Skip to content

About

Procyon Archive — a campaign database and GM workbench for Scum and Villainy

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

Procyon Archive

Overview highlights and screenshots

Procyon Archive with the sector map open

Run

Needs Docker Desktop on Windows, macOS or Linux. Procyon Archive itself is light:

  • CPU: any 64-bit, x86 or ARM.
  • Memory: about 200 MB.
  • Disk: about 1 GB, plus pictures as the campaign grows: two months of play came to 400 MB.
  • Pictures on your own GPU, optional: NVIDIA with 16 GB, 20 GB of disk, about 15 s a picture. See the local image worker.
  1. Download procyon-archive.zip from Releases and unzip it.
  2. Open a terminal in the unzipped folder and run docker compose up -d. Windows: type cmd in the folder's address bar. macOS: type cd , drag the folder into Terminal.
  3. Open http://localhost:7726.

The first start downloads about 250 MB. After that Procyon Archive starts with Docker Desktop.

Where players connect:

  • Home network: http://<your computer's local IP>:7726, like http://192.168.1.20:7726. The local IP: ipconfig on Windows, System Settings → Network on macOS, hostname -I on Linux.
  • Anywhere, from your computer: install ngrok, run ngrok http 7726 and send players the https://… address it prints. Works while your computer is on.
  • Anywhere, always on: run the same steps on a VPS with Docker and open port 7726. Players use http://<server IP>:7726. Set the admin password right after the first start.

First steps

  1. Sign in as admin / admin and set your password. Or set it before the first start: in docker-compose.yml, replace ${PA_ADMIN_PASSWORD:-} with your password.
  2. Admin space → Language: English or Russian. It sets the interface, generated texts and, by default, the presets of new campaigns: rulebook factions and places, sector map, playbooks, rules clippings.
  3. Admin space → Campaigns: create a campaign, or import from archive → DEMO_CAMPAIGN.zip to see it in action (in English).
  4. GM space → Accounts: + grant access, a login per player.
  5. Optional, pictures and news: add an OpenAI-compatible API key in Admin space → LLM and Images, or draw on your own NVIDIA GPU with the local image worker.

Manage

Run in the unzipped folder:

Stop docker compose down
Update docker compose pull then docker compose up -d
Delete all data docker compose down -v, then delete the data folder
Backup a campaign Admin space → Campaigns → export

Port 7726 busy: change it in docker-compose.yml.

Structure

backend/        API: FastAPI, PostgreSQL
frontend/       web app: React, nginx
worker/         image worker for your own GPU (optional)
assets/         rules clippings, sector map
samples/        demo campaign
docs/           pictures for this README
DEVELOPMENT.md  how to develop, deploy, release

License

Code: MIT. An unofficial fan tool: Scum and Villainy, its rulebook texts and rules clippings belong to their authors.

About

Procyon Archive — a campaign database and GM workbench for Scum and Villainy

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages