This is openakun, a (very-)work-in-progress open-source clone of the anonkun/fiction.live real-time interactive questing engine.
openakun is now testable, though development is very incomplete. Steps to run:
- Check out the repository.
- Install Poetry, if not present already. Enter the project virtualenv:
poetry shell
- Install the package and dependencies:
poetry install
- Set up a database backend. PostgreSQL is currently the only supported database backend. Ensure that a database and user have been created and you can connect in TCP mode.
- Set up Redis.
- Create the openakun configuration by copying the openakun.cfg.default file to
openakun.cfg, then set all the required values. In particular, you must set
database_url
andsecret_key
. If you want to use anything other than the default Redis, you must also setredis_url
. - Initialize the database:
openakun_initdb
- Run the development server:
openakun_server
- Run the Celery worker:
celery -A openakun.tasks worker --loglevel=INFO -B
Using Docker for development:
openakun now includes Docker config for development. To run using Docker:
- Build the image:
docker compose -f docker_compose.dev.yml build
- Ensure that your
openakun.cfg
file in the dev directory refers to the proper hosts. The Postgres URL should bepostgresql://postgres:password@postgres/postgres
. The Redis URL should beredis://redis
. - Run the image:
docker compose -f docker_compose.dev.yml up
This exposes the app on port 4430. Currently the Docker configuration is only suitable for development.