- Python 3.8+ installed (use python or python3 depending on your system).
- Git (optional) and a terminal/PowerShell.
Project dependencies are listed in requirements.txt Use a virtual environment to avoid conflicts
Unix / macOS
python3 -m venv .venv
source .venv/bin/activate
python -m pip install --upgrade pip
pip install -r requirements.txt
Windows (PowerShell)
python -m venv .venv
.\.venv\Scripts\Activate.ps1
python -m pip install --upgrade pip
pip install -r requirements.txt
Windows (Command Prompt)
python -m venv .venv
.\.venv\Scripts\activate.bat
python -m pip install --upgrade pip
pip install -r requirements.txt
To deactivate the virtual environment:
deactivate
From the repository root (with the venv activated), run the main entry script. Replace main.py with the actual launcher file if different:
python main.py
On macOS/Linux, if your system uses python3, you can run:
python3 main.py
You can also install dependencies system-wide (not recommended):
pip install -r requirements.txt
python main.py
After installing or updating packages in your virtual environment:
pip freeze > requirements.txt
- Ensure you run commands from the project root where requirements.txt and the main script live.
- If pygame installation fails on macOS, ensure you have relevant SDL libraries (install via Homebrew) or consult pygame installation docs.
- If
pythonpoints to Python 2 on your system, usepython3instead.
