Dashboard guide
Getting started
The dashboard is where you, the developer, set up a game's online services.
Make an account
Choose Get Started on the front page and register. Signing in takes you to your list of games.
Make a game
Choose Add Game in the side menu and give the game a name, and if you like a description and an image. Everything in Scoreboat belongs to a game, so this is the first step for every service.
Opening a game shows its Overview: one tile per service, with what it holds and a button to its details. The side menu then switches to that game's pages:
| Page | What it is for |
|---|---|
| Overview | The state of every service at a glance. |
| Configure | The game's name, image and player pool, and deleting it. See Games. |
| Players | The people playing, and how they may sign in. See Players. |
| Files | Buckets of files your game and its players can read and write. See Files. |
| Rooms | Real-time rooms that pass messages between players. See Rooms. |
| API Keys | The keys the game, and your own server, use to call Scoreboat. See API keys. |
Leaderboards are reached from the Leaderboards tile on the overview. See Leaderboards.
What a game needs before it can connect
A game calls Scoreboat with an API key. The usual setup is:
- Turn on the services you want.
- Issue a key for the game with the game client role, which allows what a shipped game needs (submitting scores, signing players in, using files and rooms as you allow) and nothing that changes your settings.
- Put the game's id, the key's prefix and its secret into your game, using a client library or the API.
While you can issue keys with much broader (or narrower) permimssions it is recommended that a key that is shipped inside a game's binary only has permissions it strictly needs. In most cases the game_client role is sufficient.
Any keys with broader permissions than that should live on your own servers that interface with Scoreboat as a middle man.