Before getting started, read about how OpenGB works.


Install Open Game Backend

Install Prerequisites

Install Open Game Backend

deno install -n opengb -fgA

Create project

Create a new project by running the following command:

opengb init

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


Add modules

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

opengb module add friends

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

See a list of available modules here.


Run development server

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

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.


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

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


Deploy server (optional)

Documentation coming soon.