Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/banteg/crimson/llms.txt

Use this file to discover all available pages before exploring further.

Get up and running with Crimsonland quickly using uvx.

​
Prerequisites

You’ll need Python 3.13 or higher installed on your system.
Install uv if you haven’t already: 
curl -LsSf https://astral.sh/uv/install.sh | sh

​
Run with uvx

The fastest way to run Crimsonland is using uvx, which automatically manages dependencies: 
uvx crimsonland@latest
That’s it! The game should launch and you can start playing.
Wayland on Linux: Current PyPI raylib wheels are X11-oriented on x86_64, so you may need xwayland + libX11. See electronstudio/raylib-python-cffi#199.

​
First run

On first launch, Crimsonland will:
  1. Create a runtime directory for saves, config, logs, and replays
  2. Download missing game assets if needed
  3. Initialize the game configuration
Your runtime files are stored in a per-user data directory by default:
  • Linux: ~/.local/share/crimson/
  • macOS: ~/Library/Application Support/crimson/
  • Windows: %APPDATA%\crimson\

​
Basic commands

1

Run the game

uvx crimsonland@latest
2

Skip intro logos

uvx crimsonland@latest --no-intro
3

Enable demo mode

uvx crimsonland@latest --demo
Enables shareware demo mode with limited content.
4

Use a specific seed

uvx crimsonland@latest --seed 12345
Run with deterministic RNG for reproducible gameplay.

​
Next steps

Runtime configuration

Learn how to customize runtime directories and configuration

CLI reference

Explore all available commands and options

Install from source

Set up a development environment

Game modes

Learn about Survival, Rush, Quests, and more

Build docs developers (and LLMs) love

Get started for freeTalk to us