Skip to content

Latest commit

 

History

History
73 lines (47 loc) · 2.8 KB

README.md

File metadata and controls

73 lines (47 loc) · 2.8 KB
Raw

OverviewerDocker

This project generates Docker images intended to provide a working environment for the Minecraft-Overviewer project

Here are some examples, where this may be usefull.

  • Test building the project on a clean environment (you may have incompatible Python modules installed)
  • Build on differen Linux distributions (The images are build on Ubuntu).
  • Have different, compiled versions of Minecraft-Overviewer available.

Images

After building the images, three different images are available.

mc-overview-test

This image contains The python runtime environment, a compiled master branch of Minecraft-Overviewer and all components to start rendering by starting rendertest.sh. Check README-developers.md for the prerequisites to build and customize this image.

mc-overview

This Image contains all the tools to build a functional Minecraft-Overviewer environment, including all the needed compiler components.

mc-overview-run

This Image contains only the needed Python components. If you have a working directory with a compiled Minecraft-Overviewer environment, you can use this container for the map generation. Use the Docker option -v \$PWD:/MOV to map your working directory into the docker container. Check [README-developers.md] on how to use this image.

Getting Started

Check the prerequisites in README-developers.md. You will need a recent texturepack and probably a Minecraft testworld to render.

Setup git to use LFS. See Git Large File Storage on how to do this.

Then clone this project to create your workspace.

Use the following command to create all the needed images (this will fail, unless the prerequisites are met).

bash bin/build-all.sh

The testing image will be generated as mc-overview-test

Run the test image

Use this command, to render the testworld, included in the mc-overview-test image, using the selected Minecraft-Overviewer branch.

docker run  -ti --rm mc-overview-test ./rendertest.sh

The map will be placed inside the container and deleted together with the container after the execution is finished. To keep your map, use the docker volume mappping to place a local folder into your environment.

mkdir test-map
chmod 0777 test-map
docker run  -ti --rm -v $PWD/test-map:/WRK/test-map mc-overview-test ./rendertest.sh

The processes inside the container are execudet as overviewer with UID=10001. To get proper access rights, the test-map folder is set to 0777.

Other uses

The other to images are tools for experiment and testing. Usage examples can be found in the README-developers.md document.