soleprint/docs/data/en/quickstart.md

Quick Start

Zero to running in 2 minutes.

Prerequisites

• Python 3.12+
• Docker

Setup

1. Clone the repo

git clone <repo-url> spr
cd spr

2. Initialize a room

python -m init.cli myroom

The interactive wizard walks you through layers 0-6. Accept the defaults for a standalone setup.

3. Build

python build.py --cfg myroom

This merges core framework files with your room config into gen/myroom/.

4. Run

cd gen/myroom && docker compose up

5. Open

Visit http://localhost:12000.

---

Alternative: Browser Wizard

Prefer a UI? Run the web initializer:

python -m init.web

Open http://localhost:9000 and configure your room from the browser.

Clone an Existing Room

Start from a sample configuration:

python -m init.cli myroom --from sample

This copies the sample room's config as your starting point.

Rebuild

After changing anything in cfg/myroom/, rebuild:

python build.py --cfg myroom

Then restart the containers.

Build All Rooms

python build.py --all

Ports

Service	Port
Soleprint	12000