Skip to content

The beamable product suite including com.beamable, com.beamable.server, microservice base image, portal, the installer, and build scripts

License

Notifications You must be signed in to change notification settings

beamable/BeamableProduct

Repository files navigation

Beamable Docs

Beamable C# SDK Monorepo

This repository contains the Unity C# SDK, the CLI, project templates, the Microservice framework, and various utilities. This code is available to browse, read, and understand. However, this repository is not Open Source, and usage of the code is only permitted through approved Beamable products such as the Unity SDK or the CLI.

The Unity SDK code is available under the /client/Packages folder. In Beamable 1.x, there were two packages, com.beamable, and com.beamable.server. However, in Beamable 2.0, there will be a single package, com.beamable. The /client folder is a Unity project that we use for internal testing, but nothing in the /client/Assets folder is included in any Unity SDK release.

The Microservice framework code is available under the /microservice folder, and we use the /microservice/microservice.sln solution when developing the Microservice framework. However, the solution file references the Beamable common project, in the /client/Packages/com.beamable folder.

The CLI code is available under the /cli folder, and we use the /cli/cli.sln solution when developing the CLI. However, similar to the Microservice solution, the CLI solution references .csproj files throughout the code base, including the /client/Packages/com.beamable common project.

Inside the /client/Packages/com.beamable/Common folder, there is a .csproj that declares a Net Standard 2.0 project. This common project contains most of our Beamable base types that are used across Unity, the CLI, and the Microservice.

Getting Started

This repository is for referential use only. If you're looking to get started building with Beamable, then you should head over to our documentation.

To start using the Unity SDK, https://docs.beamable.com/docs/installing-beamable

To start using the CLI directly, https://docs.beamable.com/docs/cli-guide-getting-started

Contributing

At this time, Beamable is not accepting code contributions from outside the company. However, feedback and discussion is more than welcome, so please consider posting in the Github Discussions, or report a Github Issue

License

All source code in this repository is licensed under the MS-RSL license, which is also included locally in the repository, in the LICENSE.txt file.

In short, you are free to use this code for referential use only. To use the code for any other purpose, you must use Beamable's official distributions, available through Unity Package Manager, Nuget, or Dockerhub.