1

Install prerequisites

2

Install Open Game Backend

3

Create project

Create a new project by running the following command:

opengb init

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

4

Add modules

The default project comes with a set of modules preinstalled. Install the friends module by running the following command:

opengb module add friends

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

See a list of available modules here.

5

Run development server

The development server is great for testing your scripts locally. It will hot reload when you make changes to your backend.

opengb dev
6

Generate SDK (optional)

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.

Godot, Unity, Unreal, and Rust SDKs coming soon.

7

Open in Postman/Insomnia/Firecamp/etc (optional)

The OpenAPI specification is generated at _gen/openapi.json. You can import this file into your favorite API client to start making requests to your server.

8

Deploy server (optional)

Documentation coming soon.

9

Next steps

OverviewInstall