Configuration

Nebula is configured in four places, from the inside out: the NebulaConfig asset every process loads, -nebula-* command-line switches that override individual fields at runtime, the per-project nebula.json the CLI reads, and the CLI's machine-wide config with credentials.

NebulaConfig

Assets/Resources/NebulaConfig.asset is a ScriptableObject loaded by every role (worker, gateway, orchestrator, client), so they all agree on the scene, the ports and the meshing parameters. nebula init writes a default one; the fields are edited in the Inspector. The complete list with defaults is on the NebulaConfig reference page; the ones you will touch:

The tick rate is not a setting: NetworkTime.TickRate is a constant, 60 Hz, and every worker derives its tick from the wall clock so no tick master is needed.

Command-line switches

NebulaBootstrap reads these from the process command line. The CLI and the orchestrator pass the right ones to the processes they launch; you only need them to run a role by hand. Flags are -name value or bare -name for booleans.

Standard Unity switches apply too: workers, gateway and orchestrator run with -batchmode -nographics, and -logFile <path> sets the log location the CLI uses.

nebula.json

Per-project settings that travel with the project, written by nebula init and read by every CLI command:

{
  "nebula": "0.1.0",
  "executable": "Nebula",
  "mesh": {
    "workers": 4,
    "npcs": 0,
    "dashboardPort": 7080,
    "gatewayPort": 7000,
    "spacetimeUri": "http://127.0.0.1:3000",
    "database": "nebula"
  },
  "deploy": {
    "target": "hetzner",
    "meshName": "nebula",
    "database": "nebula-mygame",
    "workers": 4,
    "npcs": 0
  }
}

The CLI's config

~/.nebula-cli/config.json (0600 on Unix) holds machine-wide settings and credentials: the Nebula source checkout nebula init copies from (nebula config source), the Unity editor path (nebula config unity), the Hetzner token, project label, region and VM types (nebula config hetzner), and the SpacetimeDB server and database for deployment (nebula config spacetime). nebula config show prints it with the token masked. HCLOUD_TOKEN in the environment always wins over the stored token.

The whole ~/.nebula-cli folder can be moved with NEBULA_CLI_HOME. It also holds the CLI binary (bin/), a shallow clone of the SDK when no source is configured (sdk/) and the mirrored project copies used to build while the Editor holds the project (scratch/).