Quickstart

• Install From GitHub (recommended)
• Build From Source

Create a new project by running the following command:

opengb init

This creates a backend.json config file. See the project configuration here.

The default project comes with a set of modules preinstalled. For example, install the lobbies module by running the following command:

opengb module add lobbies

This adds the lobbies module to the backend.json file. You can also install modules manually by adding them to this config.

The development server is great for testing your scripts locally. This will build & run your backend locally & hot reload when you make changes to the configuration.

opengb dev

Open Game Backend will generate an SDK with type-safe methods to call your scripts.

Replace <output> with the path where you want to generate the SDK. Replace <target> with the target language.

opengb sdk generate --output <output> <target>

See the SDK docs for instructions on how to use the generated SDK.

Install the Rivet CLI, then run the following:

rivet init
rivet deploy prod

See self-hosting instructions here.