Development Commands

Installation

Prefer uv over pip for faster installs.

uv pip install -e .          # or `make install`
uv pip install -e .[extra]   # optional deps (crypto, SSL, Jupyter, scipy, etc.)

Game Lifecycle

evennia --init mygame    # create new game directory
cd mygame && evennia migrate
evennia start / stop / reload
evennia shell            # Django-aware Python shell
evennia istart           # interactive mode (for debugging with set_trace)

Testing

The make targets call bare evennia and require it installed in the active environment. With uv run, init the test game dir yourself first (see Testing for full details):

# uv run (preferred — works without global install):
uv run evennia --init .test_game_dir && cd .test_game_dir && uv run evennia migrate
uv run evennia test --keepdb evennia.server.tests   # from inside .test_game_dir/

# make (requires `evennia` on PATH):
make test                                        # full suite
make testp                                       # parallel (4 cores)
make TESTS=evennia.objects.tests test             # specific module
make TESTS=evennia.commands.tests.test_command test  # specific test file

Formatting

make format   # black + isort
make lint     # black --check

PR Conventions

Feature PRs and contribs go against the develop branch
Critical fixes go against main
Keep unrelated changes in separate branches/PRs

1.5 KiB Raw Permalink Blame History