Skip to content

Getting Started

The fastest way to understand Arepy is:

  1. install the project
  2. create an ArepyEngine
  3. create a World
  4. spawn entities with world.create_entity() and EntityBuilder
  5. add systems to a SystemPipeline
  6. set the current world and call run()

In this section

  • Installation covers package installation and local setup with uv
  • Quickstart walks through a minimal movement example

If you want a larger sample project after the quickstart, check examples/bunnymark.py in the repository.

The goal of this section is to get you from “installed” to “I have a world running” as quickly as possible.