Central Command

The all-in-one backend application for Unitystation

Features

• Account management and user validation.
• Server list management.
• In-game persistence.
• Works cross-fork!
• Modular architecture.

Development guide

Settings file

Copy example.env to .env and customize it.

Setting up python

You will need python 3.11+

Extra steps if don't want to install poetry globally for some reason

Install venv (only first time or after updating sytem python version)

python -m venv .venv

Activate venv on Linux

. .venv/bin/activate

Activate venv on Windows

.venv\Scripts\activate

Dependency installation

Install poetry to manage dependencies and update pip

pip install -U pip poetry

Install dev dependencies

poetry install

pre-commit

pre-commit is a git hook which runs every time you make a commit to catch linting and formatting errors early.

pre-commit install

Hint: if the world is on fire, production servers down, clown at your doorstep and you don't have time to make linters happy, add -n to git commit command (CI will still be mad though).

Setting up Docker

Docker (with help of compose) lets you launch entire project including database locally without installing anything.

1- To get started with docker, install it from here and (optionally) install docker engine.

2- Launch project by running docker compose -f dev-compose.yml up --build.

3- Test out the webui by accessing http://localhost:8000/

Navigating web UI

Assuming you've managed to get a page running on http://localhost:8000/, we can now start doing things such as registering a test account.

• http://localhost:8000/admin -> View all accounts and edit existing ones.
• http://localhost:8000/accounts/register -> Create an account (if you already don't have one)
• http://localhost:8000/accounts/verify-account -> Test account verfication manually.

To find more api end points or add new ones, check out urls.py under the respective folder of what feature you want mess around with.