Redwood

https://redwoodmmo.com/docs
Admin
Redwood is a self-hosted, source-available game backend as a service (GBaaS) designed for scalable...
Tokens:73,943
Snippets:517
Trust Score:5.6
Update:1 month ago
Show doc for...
Tokens:
Raw
### Install Node.js v20 with NVM

Source: https://redwoodmmo.com/docs/getting-started/prerequisites

Install and use Node.js v20 with NVM. The first block is for Windows, the second for Mac/Linux. Run these after installing NVM.

```bash
nvm install 20  
nvm use 20  
```

```bash
nvm install 20  
```

--------------------------------

### Example configuration for packaged build

Source: https://redwoodmmo.com/docs/features/game-servers/hosting/local

Example Realm Instance Config snippet showing how to configure the local provider to use a packaged/cooked build. It sets the path and executable to the build output and leaves the project as an empty string.

```yaml
game-servers:  
  local:  
    unreal:  
      path: "C:\\Path\\To\\MyGame\\builds\\WindowsServer\\MyGame\\Binaries\\Win64"  
      executable: "MyGameServer.exe"  
    project: ""  
```

--------------------------------

### Create GameServerProxy with yarn cli create-proxy

Source: https://redwoodmmo.com/docs/getting-started/running-with-backend

Creates a GameServerProxy for the overworld game profile. The --start-on-boot flag starts the proxy immediately and on backend boot (admin only), while --proxy-ends ends the proxy when its backing GameServerCollection ends. This starts a shard/server for each zone (5 for this template), each running UnrealEditor.exe and consuming about 1.2GB RAM.

```bash
yarn cli create-proxy overworld overworld --env project-name --start-on-boot --proxy-ends --public  

```

--------------------------------

### Enable corepack and install backend dependencies

Source: https://redwoodmmo.com/docs/getting-started/installing

Run these commands in the RedwoodBackend directory to enable corepack, verify yarn version 4.10.3 or later, and install dependencies.

```bash
corepack enable  
```

```bash
yarn --version  
4.10.3  
```

```bash
yarn  
```

--------------------------------

### Run ngrok tunnel for Hathora development

Source: https://redwoodmmo.com/docs/features/game-servers/hosting/hathora

Starts an ngrok tunnel on port 3010 so the Realm Backend service can be reached by game servers on Hathora. Requires ngrok installed and on your PATH.

```bash
ngrok http 3010
```

--------------------------------

### C++ Steam login: get client interface and call LoginWithSteam

Source: https://redwoodmmo.com/docs/features/authentication/steam

These two C++ steps are part of the Steam login setup: first obtain the active Redwood Client interface from the game subsystem, then call LoginWithSteam with an auth update delegate. Replace OnUpdate with your own callback to handle the auth update.

```cpp
URedwoodClientInterface *ClientInterface = GetGameInstance()->GetSubsystem<URedwoodClientGameSubsystem>()->GetClientInterface();  
```

```cpp
URedwoodSteamClientInterface::LoginWithSteam(ClientInterface, FRedwoodAuthUpdateDelegate OnUpdate);  
```

--------------------------------

### Create pulumi.yaml with project name

Source: https://redwoodmmo.com/docs/deploying-to-kubernetes/deploying-locally

Create a deployment/pulumi.yaml file in the config folder (e.g., config/node/redwood-demo-kubernetes/deployment/pulumi.yaml) with the project name. Example shows project: "redwood-demo".

```yaml
project: "<project-name>"  
```

```yaml
project: "redwood-demo"  
```

--------------------------------

### Example _config.json with parentNames

Source: https://redwoodmmo.com/docs/configuration/overview

Shows a _config.json file for a redwood-demo-production environment that inherits from production and cloud-do. The parentNames array defines the order of inheritance: default, then production (and its parents), then cloud-do, then the current environment.

```json
{
  "parentNames": ["production", "cloud-do"]  
}

```

--------------------------------

### RPG template game.yaml profiles example

Source: https://redwoodmmo.com/docs/configuration/game-modes-and-maps

Example game.yaml for the RPG template. Shows an overworld profile with multiple zones sharing maps and sharding settings (num-players-to-add-shard: 50, commented-out destroy-empty-shard), plus an instanced-dungeon profile with matchmaking enabled.

```yaml
profiles:  
  - id: "overworld"  
  
    zones:  
      variableCasing: "original"  
      village:  
        maps:  
          - "overworld"  
      outskirts:  
        maps:  
          - "overworld"  
      mountain-pass:  
        maps:  
          - "overworld"  
      forest:  
        maps:  
          - "overworld"  
      mine:  
        maps:  
          - "mine"  
  
    max-players-per-shard: 16  
  
    num-players-to-add-shard: 50  
    # num-minutes-to-destroy-empty-shard: 5  
    collection-ends-when-any-shard-ends: false  
  
    data:  
  
  - id: "instanced-dungeon"  
  
    zones:  
      variableCasing: "original"  
      main:  
        maps:  
          - "dungeon"  
  
    max-players-per-shard: 16  
  
    matchmaking-zone-name: "main"  
    min-players-for-matchmaking: 1  
  
    data:  

```

--------------------------------

### Match template game.yaml profiles example

Source: https://redwoodmmo.com/docs/configuration/game-modes-and-maps

Example game.yaml for the Match template. Defines two profiles (elimination and control) each with a single zone and map, max players per shard, matchmaking settings, and a data key/value pair that is passed to the map load URL.

```yaml
profiles:  
  - id: "elimination"  
  
    zones:  
      main:  
        maps:  
          - "expanse"  
  
    max-players-per-shard: 16  
  
    matchmaking-zone-name: "main"  
    min-players-for-matchmaking: 1  
  
    data:  
      Experience: "B_ShooterGame_Elimination"  
  
  - id: "control"  
  
    zones:  
      main:  
        maps:  
          - "convolution"  
  
    max-players-per-shard: 16  
  
    matchmaking-zone-name: "main"  
    min-players-for-matchmaking: 1  
  
    data:  
      Experience: "B_LyraShooterGame_ControlPoints"  

```

--------------------------------

### Build and package match-function

Source: https://redwoodmmo.com/docs/deploying-to-kubernetes/deploying-remotely

Run these commands if you updated the `packages/match-function` source to build the backend and generate the prepackaged binaries.

```bash
yarn build && yarn pkg:match-function  

```

--------------------------------

### Launch backend with Dev Initiator and yarn dev

Source: https://redwoodmmo.com/docs/getting-started/running-with-backend

Run these commands in the RedwoodBackend directory to launch the backend. Replace <your-config-env> with the name of your config folder, and <config-environment> with the environment name (e.g., project-name). The ./ prefix may be optional depending on your terminal; macOS and Linux users can use dev-initiator-mac or dev-initiator-lin instead. Wait for the 'All services ready' log before proceeding.

```bash
./dev-initiator-win <your-config-env>  
```

```bash
yarn dev <config-environment>  
```

--------------------------------

### Configure DefaultEngine.ini for EOS Online Subsystem

Source: https://redwoodmmo.com/docs/features/authentication/epic

Add this configuration to your UE project's Config/DefaultEngine.ini to enable the EOS online subsystem without enabling EOS networking settings. As of Jan 2026, this basic config sets the default platform service to EOS and disables EOS Connect, sessions, and mirroring. Do not change the NetDriver as suggested in other Steam setup guides.

```ini
[/Script/OnlineSubsystemEOS.EOSSettings]  
CacheDir=CacheDir  
DefaultArtifactName=GameName  
RTCBackgroundMode=  
TickBudgetInMilliseconds=0  
bEnableOverlay=False  
bEnableSocialOverlay=False  
bEnableEditorOverlay=False  
bPreferPersistentAuth=False  
TitleStorageReadChunkLength=0  
+Artifacts=(ArtifactName="GameName",ClientId="***",ClientSecret="***",ProductId="***",SandboxId="***",DeploymentId="***",ClientEncryptionKey="")  
-AuthScopeFlags=BasicProfile  
-AuthScopeFlags=FriendsList  
-AuthScopeFlags=Presence  
bUseEAS=True  
bUseEOSConnect=False  
bMirrorStatsToEOS=False  
bMirrorAchievementsToEOS=False  
bUseEOSSessions=False  
bMirrorPresenceToEAS=False  
SteamTokenType=Session  
  
[OnlineSubsystemEOS]  
bEnabled=true  
  
[OnlineSubsystem]  
DefaultPlatformService=EOS  
```

--------------------------------

### Install K3s with Traefik disabled

Source: https://redwoodmmo.com/docs/deploying-to-kubernetes/deploying-remotely

Use this command to install K3s while disabling the default Traefik ingress controller. This is required for K3s unmanaged clusters. Alternatively, you can modify /etc/systemd/system/k3s.service to add the --disable=traefik argument to the server command if K3s is already installed.

```bash
curl -sfL https://get.k3s.io | sh -s - --disable=traefik
```

--------------------------------

### Install Node.js dependencies with yarn

Source: https://redwoodmmo.com/docs/deploying-to-kubernetes/deploying-locally

Run this command in the RedwoodBackend directory to install dependencies. It automatically triggers a build; you can recompile manually with 'yarn build'.

```bash
yarn  
```

--------------------------------

### Sample yarn docker output

Source: https://redwoodmmo.com/docs/deploying-to-kubernetes/deploying-remotely

Sample output from running `yarn docker redwood-demos-prod -l`, showing the building and pushing of three images to the registry with the 'latest' tag.

```bash
$ yarn docker redwood-demos-prod -l  
Pulling latest base images...  
Initiating building & pushing 3 images to registry: registry.digitalocean.com at path: incanta-generic-cr  
  
Image 1/3: redwood-demos-core-runner:3.0.1-4  
        Checking registry...  
        Building image...  
        Pushing image...  
        Adding 'latest' tag...  
  
Image 2/3: redwood-demos-match-function:3.0.1-4  
        Checking registry...  
        Building image...  
        Pushing image...  
        Adding 'latest' tag...  
  
Image 3/3: redwood-demos-game-server-rpg:3.0.1-4  
        Checking registry...  
        Building image...  
        Pushing image...  
        Adding 'latest' tag...  
Done in 396.92s.  

```

--------------------------------

### Example region configuration for production environment

Source: https://redwoodmmo.com/docs/deploying-to-kubernetes/deploying-remotely

Example region configuration for a production environment. The name and ping variables are used in the GetRegions call in URedwoodClientGameSubsystem. The ping variable may need adjustment if using CloudFlare proxying.

```yaml
region:  
  provider-id: "sfo3"  
  name: "US West"  
  ping: "${director.frontend.connection.external.host}" # this might not be correct if you're using CloudFlare proxying (which Redwood uses by default when using the Cloudflare DNS provider)  

```

--------------------------------

### Pulumi preview output for local deployment

Source: https://redwoodmmo.com/docs/deploying-to-kubernetes/deploying-locally

Shows the expected output when running `yarn deploy` locally. The preview lists all resources that will be created, including Docker images, Kubernetes resources, and Helm releases. The user is prompted to confirm the update.

```text
Created stack 'incanta/dev-mike'  
Previewing update (incanta/dev-mike)  
  
View in Browser (Ctrl+O): https://app.pulumi.com/incanta/redwood-demo/dev-mike/previews/2f235049-fc1c-49c7-9172-f20f374aed82  
  
    Type                                                     Name                                     Plan  
+   pulumi:pulumi:Stack                                      redwood-demo-dev-mike                    create  
+   ├─ docker:index:Image                                    yourcr.com/container/redwood-dev-image   create  
+   ├─ docker:index:Image                                    yourcr.com/container/game-server-image   create  
+   ├─ pulumi:providers:kubernetes                           k8s-provider-local                       create  
+   ├─ kubernetes:core/v1:ConfigMap                          game-server-config-map-local             create  
+   ├─ kubernetes:helm.sh/v3:Release                         redis                                    create  
+   ├─ kubernetes:helm.sh/v3:Release                         ingress                                  create  
+   ├─ kubernetes:helm.sh/v3:Release                         open-match                               create  
+   ├─ kubernetes:helm.sh/v3:Release                         mongo                                    create  
+   ├─ kubernetes:helm.sh/v3:Release                         agones-local                             create  
+   ├─ kubernetes:core/v1:ConfigMap                          director-frontend-config-map-local       create  
+   ├─ kubernetes:core/v1:ServiceAccount                     realm-backend-account-local              create  
+   ├─ kubernetes:core/v1:ConfigMap                          director-backend-config-map-local        create  
+   ├─ kubernetes:rbac.authorization.k8s.io/v1:Role          gameservers-allocations-role-local       create  
+   ├─ kubernetes:core/v1:ConfigMap                          match-function-config-map-local          create  
+   ├─ kubernetes:networking.k8s.io/v1:Ingress               director-ingress-local                   create  
+   ├─ kubernetes:agones.dev/v1:Fleet                        agones-fleet-local                       create  
+   ├─ kubernetes:apps/v1:StatefulSet                        director-frontend-local                  create  
+   ├─ kubernetes:autoscaling.agones.dev/v1:FleetAutoscaler  agones-fleet-autoscaler-local            create  
+   ├─ kubernetes:apps/v1:StatefulSet                        match-function-local                     create  
+   ├─ kubernetes:rbac.authorization.k8s.io/v1:RoleBinding   read-gameservers-write-allocation-local  create  
+   ├─ kubernetes:core/v1:Service                            director-frontend-debug-local            create  
+   ├─ kubernetes:core/v1:Service                            director-frontend-local                  create  
+   ├─ kubernetes:core/v1:Service                            match-function-debug-local               create  
+   ├─ kubernetes:core/v1:Service                            match-function-local                     create  
+   ├─ kubernetes:apps/v1:StatefulSet                        director-backend-local                   create  
+   ├─ kubernetes:core/v1:Service                            realm-backend-local                      create  
+   ├─ kubernetes:core/v1:Service                            director-backend-debug-local             create  
+   └─ kubernetes:core/v1:Service                            director-backend-local                   create  
Outputs:  
    k8sId: "Local Deployment"  
  
Resources:  
    + 29 to create  
  
Do you want to perform this update?  [Use arrows to move, type to filter]  
  yes  
> no  
  details  

```

--------------------------------

### Create config environment inheriting from production and local Kubernetes config

Source: https://redwoodmmo.com/docs/deploying-to-kubernetes/deploying-remotely

Create a new configuration environment that inherits from the 'production' preset and the local Kubernetes config environment. The first block is the template with a placeholder; the second is a concrete example using 'redwood-demo-kubernetes'.

```json
{
  "parentNames": ["production", "<project-kubernetes-config-environment>"]
}
```

```json
{
  "parentNames": ["production", "redwood-demo-kubernetes"]
}
```
Tokens:
Raw