Skip to content

Installation

Requirements

To get Arepy running, you currently need:

  • Python 3.11+
  • bitarray
  • raylib

Install from PyPI

pip install arepy

If you only want to use the engine in a game project, that is enough.

Local setup with uv

git clone https://github.com/Scr44gr/arepy.git
cd arepy
uv sync --extra docs

This gives you the runtime dependencies plus the documentation toolchain used by this site.

Build the docs locally

uv run mkdocs build

Optional extras

If you want to work on the ImGui integration too:

uv sync --extra docs --extra imgui

If you are contributing to the project itself and need the full contributor workflow, use CONTRIBUTING.md as the source of truth.

Common next steps