Skip to content

pythonfoo/fantasy_forge

 
 

Repository files navigation

Fantasy Forge (working title)

Let's Go!

Clone the repo, change into the directory, and run uv run -m fantasy_forge to start the game. uv will create a fitting virtualenv for you. You can install uv using pipx.

So initially, if you don't have it:

pipx install uv
git clone https://github.com/pythonfoo/fantasy_forge

And to start:

cd fantasy_forge
# call the module
uv run -m fantasy_forge
# or run the command
uv run fantasy-forge

You can also set a debug level to write debugging output to ./fantasy_forge.log.

Development

pre-commit

See pre-commit docs and the ruff-hook

# Install `pre-commit` with e.g.
pipx install pre-commit
# install the pre-commit file (.pre-commit-config.yaml) with
pre-commit install
# run it (perhaps multiple times), to see if everything works
pre-commit run --all-files

Tests (TBD :D)

Unittests via pytest live in ./tests/unittests

Integration tests via hitchstory and pytest are in ./tests/integration

About

Fantasy Forge is a framework for creating and playing text adventure games.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 12