Skip to content

Images

Client images are hosted in the GitHub Container Registry as ghcr.io/caunt/portable-minecraft-client. Every published image supports linux/amd64 and linux/arm64.

Browse the published client images for the current tags and digests.

Tag Contents Recommended use
latest Current client runtime. Game assets are prepared when requested. General use and the Void demo.
offline Mojang release assets from 1.7.2 through the latest release available when the image was published. Integration suites that exercise many versions.
<minecraft-version> Assets prepared for one Mojang release, such as 1.7.2 or 1.21.8. Workflows fixed to one game version.

The latest and offline tags are replaced when new images are published. Version tags are also rebuilt by the publishing workflow and identify prepared game assets, not a permanent image build. Pin an image digest when a workflow must use identical image contents.

Pull the current runtime image:

Terminal window
docker pull ghcr.io/caunt/portable-minecraft-client:latest

Pull the multi-version image used by Void integration tests:

Terminal window
docker pull ghcr.io/caunt/portable-minecraft-client:offline

Pull an image prepared for a specific release:

Terminal window
docker pull ghcr.io/caunt/portable-minecraft-client:1.21.8

Pin exact image contents with a digest from the package page:

Terminal window
docker pull ghcr.io/caunt/portable-minecraft-client@sha256:<digest>

Minecraft data is stored in /root/.minecraft by default. Mount a volume to keep downloaded assets, options, mods, and other game files when the container is replaced:

Terminal window
docker volume create void-client-minecraft
docker run --name void-client --rm -d -p 8080:80 \
--volume void-client-minecraft:/root/.minecraft \
ghcr.io/caunt/portable-minecraft-client:latest

Use MINECRAFT_DIRECTORY when mounting the data at another container path:

Terminal window
docker run --name void-client --rm -d -p 8080:80 \
--env MINECRAFT_DIRECTORY=/minecraft \
--volume void-client-minecraft:/minecraft \
ghcr.io/caunt/portable-minecraft-client:latest

Starting a CurseForge modpack requires CURSEFORGE_API_KEY:

Terminal window
docker run --name void-client --rm -d -p 8080:80 \
--env CURSEFORGE_API_KEY=your-api-key \
ghcr.io/caunt/portable-minecraft-client:latest

CURSEFORGE_API_BASE_URL optionally replaces the default https://api.curseforge.com API base URL.