WorldMaster

WorldMaster is a platform for managing, running, sharing, and recording online TTRPG games.

Development

The main development branch lives on Codeberg, and is the perferred location for issues and pull requests.

When developing, there is an easy set of containers available. You work with these via just:

dev                # Start up the dev pod.  This is like the django pod, but just sets up the venv and drops you into a shell.
dev-shell          # Run a shell on the dev pod.
django             # Run the django pod, which runs `runserver`.
django-admin *args # Run a django-admin command on the dev pod.
down               # Tear down running worldmaster pods.
down-dev           # Tear down the dev pod.
down-django        # Tear down the django pod.
down-watchtsc      # Tear down the watchtsc pod.
image name         # Build the named image as the worldmaster tag.
images             # Build all images.
makemigrations
pods               # Start up development pods.  This is necessary to access the site on a web browser.
push-image name    # Push the named image as the worldmaster tag.
push-images        # Push all images.
test
watchtsc           # Run the watchtsc pod, which compiles typescript to js on all changes into the shared static volume.

All docker resources are prefixed with worldmaster-.

You can clean them with

just clean

Which might be necessary to update dependencies.

podman is the default container runner. If you prefer to use docker, set your DOCKER environment variable to docker, or set the docker just variable.

DOCKER=docker just
just docker=docker

When the containers are running, you can access django like usual, by going to 127.0.0.1:8000.

• You should not use localhost, because if that resolves to an IPv6 address, it will fail to resolve. We can only listen on ipv4 or ipv6, not both at the same time).

• The first run of worldmaster-django will take a some time before it starts listening, becuase running the migrations takes a while.

• You can use podman container attach worldmaster-django to attach to the running container and see its output. podman container logs -f worldmaster- django will do something similar, but without killing the container on exit.

• Containers are started with --rm. Their persistent state is kept in volumes, not the container filesystem.

• You can rebuild images with just images. This shouldn't be necessary unless you want to change or update the development image.