Logo FSBarV1_Archived

HubSettings Type

JSON-serialisable record. All fields are required on write; missing fields on read are filled from `defaults`.

Record fields

Record Field Description

BarDataDirOverride

Full Usage: BarDataDirOverride

Field type: string option

Absolute path to the BAR data directory. `None` uses the XDG default (`$HOME/.local/state/Beyond All Reason`).

Field type: string option

EngineVersionOverride

Full Usage: EngineVersionOverride

Field type: string option

Pinned engine version (e.g. `"2026.03.14"`). `None` selects the newest installed `recoil_*` directory.

Field type: string option

GrpcPort

Full Usage: GrpcPort

Field type: int

Localhost TCP port the hub's gRPC scripting service binds. Validated to `[1024, 65535]` on load; out-of-range loads trigger a fallback to `defaults.GrpcPort`.

Field type: int

LaunchGraphicalViewerDefault

Full Usage: LaunchGraphicalViewerDefault

Field type: bool

Initial state of the "Launch original BAR viewer" toggle on the Setup tab (US4).

Field type: bool

MaxLogStreamSubscribers

Full Usage: MaxLogStreamSubscribers

Field type: int

Maximum number of concurrent `StreamHubLog` subscribers served by `HubLog` (feature 042, FR-015a). Validated to `[1, 32]`; default `8`. Persisted starting at schema v3. v2 files load this field as the default and are rewritten as v3 on the next `save`.

Field type: int

MaxRenderFrameSubscribers

Full Usage: MaxRenderFrameSubscribers

Field type: int

Maximum number of concurrent `StreamRenderFrames` subscribers served by `HeadlessRenderer` (feature 040 US2). Validated to `[1, 32]`; default `8`. Persisted starting at schema v2. v1 files load this field as the default and are rewritten as v2 on the next `save`.

Field type: int

SchemaVersion

Full Usage: SchemaVersion

Field type: int

Schema version. Currently `3` (feature 042 bumped from 2 when `MaxLogStreamSubscribers` was added; feature 040 bumped from 1 when `MaxRenderFrameSubscribers` was added). Increments when additive / destructive changes require a migration step on load; missing-field additions do not bump.

Field type: int

StartPausedDefault

Full Usage: StartPausedDefault

Field type: bool

Initial state of the "Start paused" toggle on the Setup tab (feature 038, FR-004a). Defaults to `true` on fresh install; persisted across Hub restarts. When `true`, every launched match starts paused via a `/pause` chat command on the first `Running` transition.

Field type: bool

Type something to start searching.