Concepts
Project
Section titled “Project”A project is one game. It has members (operators of the Dashboard, each with a
role), installed modules, catalogs, currencies and the start of its
day. Find the id of a project in the address of the Dashboard:
app.rudder.build/projects/<project id>.
Environments
Section titled “Environments”Every project has two environments, staging and production (staging and prod in
the API and the CLI). Each has its own players, its own data and its own releases, and two keys:
| Key | Who holds it | What it does |
|---|---|---|
| SDK key | The game client. It ships in the build, so it is no secret. | Signs devices in and selects the environment. |
| Server key | Your game server only. It is shown once, when it is issued. | Calls any function for any player, and updates a profile or a ban. |
Both keys are on Settings of the project. Issuing a new key stops the old one at once. The
SDK tells the environment of the key: session.environment on the client and environment() on
the server, staging or prod.
Modules
Section titled “Modules”A module is a feature of the game: its data, its functions, the catalogs a designer fills and the pages it adds to the Dashboard.
- Marketplace modules are written and kept up to date by Rudder: Stores, Quests, Leaderboards, Inventory and more. You install them in a click.
- Your own modules hold what is unique to your game, written with the
rudderCLI (see Own modules). A module of your game usually requires marketplace modules and calls them.
A module has functions. A query reads; a mutation changes data. A function marked
server can be called only by your game server and by operators, never by a client.
Catalogs and currencies
Section titled “Catalogs and currencies”A catalog is a table of rows a designer fills in the Dashboard: the offers of a store, the quests, the boards. The module declares what a row holds; the Dashboard builds the form from it and checks each row when it is saved.
A currency (gems, gold) belongs to the project. Every balance of every player is in one of them, and every change of a balance is in the history of the player.
Drafts and releases
Section titled “Drafts and releases”The draft is what you edit: the installed module versions, the catalogs, the currencies and the start of the day. Nothing in the draft reaches players until you publish it.
A release is a frozen copy of the draft. Publish the draft makes the next release of staging. Promote gives a staging release to production as its next release. Roll back publishes an older release again as a new version; the draft stays as it is. The newest release of an environment is what its players get, at once.
Players
Section titled “Players”A player is created at the first sign-in of a device and lives in one environment. The client never names a player: it calls on its own. The game server and operators name a player by its Rudder player id, which the client gets at sign-in.
The day of the project
Section titled “The day of the project”Periods (a daily limit, a weekly board, a monthly quest) start at the day start of the
project, a time in UTC set on Settings (00:00 by default). Weeks start on Monday and
months on their first day, both at the day start.
Addresses
Section titled “Addresses”| Address | What reaches it |
|---|---|
https://app.rudder.build | The Dashboard, in a browser. |
https://api.rudder.build | The Rudder API: the rudder CLI, your game client, your game server and your tools. |
The CLI keeps the project you work on in your repository (see CLI).