Scoreboat documentation

Scoreboat is a simple service intended to provide simple plug and play web functionality to small games; such as leaderboards, cloud file storage, player management, sockets, and (hopefully) more. This documentation describes the services, what we currently offer, how our API endpoints work, and our officially supported client services.

The contents of these docs are programatically generated from the latest published codebase and function descriptions.

Dashboard guideMake a game, turn on its services and issue the keys it will use. APIEvery endpoint, how to get a token, and what a key may be allowed to do. ClientsLibraries that do the talking for you. Currently only GameMaker.

Where to start

Make an account and a game in the dashboard.
Turn on the services the game needs: leaderboards, players, files or rooms.
Issue an API key for the game to ship with.
Use it from a client library, or call the API yourself.

The reference pages (the API endpoints, the permission catalogue and the GameMaker functions) are generated from Scoreboat's source code, so they match the version of Scoreboat that is serving them. Until we get proper versioning running assume that the state of the endpoints is in a bit of a flux. We'll eventually get around to making API versioning set up so that you always know what to expect.