Remote config
Values the game reads at start and a designer changes without a client release: a switch for a feature, a number for a balance tweak, a text for a message of the day, a JSON document for everything that has a shape of its own.
const config = await rudder.config.all();Catalogs: Switches, Numbers, Texts, JSON
Section titled “Catalogs: Switches, Numbers, Texts, JSON”Config → Remote config shows the four catalogs as one table. Add asks for the type of the value; the type of a row never changes.
| Catalog | value |
|---|---|
switches | a boolean, shown as a switch |
numbers | an integer |
texts | a string |
jsons | a JSON document of any shape, written as text |
Each row has a key, its value and a description for the team.
A jsons row holds one JSON value: an object, an array or a single value, nested as deep as it
needs to be. The Dashboard shows it as one line in the table and, on the row itself, as formatted
text with its keys in the order they were written; a value that is not valid JSON cannot be
saved. The generated client gives it the type each language has for a value of unknown shape
(unknown in TypeScript, object? in C#): the game decides what the document holds.
Visibility
Section titled “Visibility”A row is client (the default) or server, and the Dashboard shows them as Everyone and
Server only. The game client reads the client rows only: a server row never appears in
all, so neither its key nor its value reaches a game build. The game server reads every row
through values, called with the admin key of the environment. A row saved before this flag
existed reads as client.
Functions
Section titled “Functions”| Function | Kind | Caller | Arguments | Result |
|---|---|---|---|---|
all | query | client | none | {switches: {key: boolean}, numbers: {key: integer}, texts: {key: string}, jsons: {key: JSON}} |
values | query | game server | none | the same shape, with the server rows too |
Limits
Section titled “Limits”- One value per environment: staging and production differ by their releases.
- No targeting by a time window, a region or a language.
- A JSON value is at most 64 KiB written without spaces, so a config of a few documents stays small enough to reach every client at start.
serveris a label, not a secret: the row stays visible in the Dashboard and in the catalog of the project. A key that must never be readable by a designer belongs in the project settings of the environment, not here.