Skip to main content
Install the latest stable release of Crimsonland from PyPI. The recommended way to run Crimsonland is using uvx, which handles dependencies automatically without polluting your global Python environment.
1

Install uv

If you haven’t already, install uv:
curl -LsSf https://astral.sh/uv/install.sh | sh
2

Run Crimsonland

uvx crimsonland@latest
This automatically:
  • Downloads and installs Crimsonland and its dependencies in an isolated environment
  • Runs the game
  • Keeps your system Python clean
With uvx, you don’t need to install Crimsonland globally. Each run uses an isolated environment.

​
Using pip

If you prefer traditional pip installation:
1

Create a virtual environment (recommended)

python3 -m venv .venv
source .venv/bin/activate  # On Windows: .venv\Scripts\activate
2

Install Crimsonland

pip install crimsonland
3

Run the game

crimsonland
# or
crimson
Both commands are aliases for the same CLI.

​
Version pinning

To install a specific version: 
uvx [email protected]

​
Optional dependencies

To install with chart rendering support (used by some analysis tools): 
pip install crimsonland[charts]
This installs additional dependencies:
  • altair for data visualization
  • vl-convert-python for chart rendering

​
Verification

Verify the installation: 
crimson --help
You should see the CLI help output with available commands.

​
Platform-specific notes

​
Linux (Wayland)

Current PyPI raylib wheels are X11-oriented on x86_64. Wayland users may need xwayland + libX11.
Install X11 compatibility: 
# Ubuntu/Debian
sudo apt install xwayland libx11-6

# Fedora
sudo dnf install xorg-x11-server-Xwayland libX11

# Arch
sudo pacman -S xorg-xwayland libx11
See electronstudio/raylib-python-cffi#199 for details.

​
Upgrading

To upgrade to the latest version: 
# uvx always uses latest by default
uvx crimsonland@latest

​
Uninstalling

# uvx doesn't install globally, but you can clear its cache
uv cache clean
Uninstalling the package does not remove your runtime files (saves, config, replays). See Runtime configuration to locate these files.

​
Next steps

Runtime configuration

Customize where saves, config, and replays are stored

CLI reference

Learn about all available commands

Game modes

Explore Survival, Rush, Quests, and more

Assets setup

Configure custom asset directories

Build docs developers (and LLMs) love

Get started for freeTalk to us