/minecraft-overviewer

Docker Image to Run Minecraft Overviewer

Primary LanguagePythonMIT LicenseMIT

Minecraft Overviewer Docker Image

Docker Docker GitHub license GitHub issues Build Status

Docker Image to Run Minecraft Overviewer. Overviewer is a render that produces a render of a Minecraft world.

Goals

The goal of this image is to easily run Minecraft Overviewer. Now you don't need to worry about the dependencies.

Running Minecraft Overviewer

docker pull mide/minecraft-overviewer:latest
docker run \
  --rm \
  -e MINECRAFT_VERSION="1.14" \
  -v /home/user/minecraft/:/home/minecraft/server/:ro \
  -v /srv/http/minecraft/:/home/minecraft/render/:rw \
  mide/minecraft-overviewer:latest

Environment Variables

Required

  • MINECRAFT_VERSION Set to the version of Minecraft the world is based from (Like 1.14). Used for textures.

Optional

  • ADDITIONAL_ARGS Default Value: null. Set to contain any additional arguments you'd like to pass into overviewer.py.

  • CONFIG_LOCATION Default Value: /home/minecraft/config.py. Set to a different path to override the provided configuration. This only makes sense if you have a different configuration in a volume.

  • RENDER_MAP Default Value: true. Set to false if you do not want to render the map. This is useful for POI only-updates.

  • RENDER_POI Default Value: true. Set to false to disable rendering of POI (points of interest).