From 32d6946919bdd46709e7fa7b036253d0bd05d58a Mon Sep 17 00:00:00 2001 From: saibotk Date: Tue, 18 Jun 2019 14:06:23 +0200 Subject: [PATCH] fix checksum and update readme --- Dockerfile | 2 +- README.md | 36 +++++++++++++++++++++++++++++++++++- 2 files changed, 36 insertions(+), 2 deletions(-) diff --git a/Dockerfile b/Dockerfile index 90edd54..9b99ce5 100644 --- a/Dockerfile +++ b/Dockerfile @@ -12,7 +12,7 @@ ENV OUTPUT=/blockmap/output \ INPUT_NETHER=/blockmap/input/DIM1/region \ INPUT_END=/blockmap/input/DIM-1/region \ VERSION=1.4.0 \ - SHA1=cada13d8c9bba4a8dd1ed3017fd04a4a03695ca3 + SHA1=6b51f4d3d23094da2820d9461036a618c2933083 RUN mkdir -p /opt/blockmap /blockmap && \ apk add --update --no-cache su-exec binutils gettext libintl && \ diff --git a/README.md b/README.md index 7ed41fb..0bf308e 100644 --- a/README.md +++ b/README.md @@ -1 +1,35 @@ -BlockMap-Docker +# BlockMap-Docker [![](https://images.microbadger.com/badges/version/saibotk/blockmap.svg)](https://hub.docker.com/r/saibotk/blockmap/) [![](https://images.microbadger.com/badges/image/saibotk/blockmap.svg)](https://hub.docker.com/r/saibotk/blockmap/) [![](https://img.shields.io/docker/pulls/saibotk/blockmap.svg?maxAge=600)](https://hub.docker.com/r/saibotk/blockmap/) + +*Available tags:* +* `latest` - most up-to-date version (can be **unstable**!). +* `x.x.x` - a specific version. + +# What is BlockMap? + +BlockMap is a Mincraft map renderer written in Java, which is able to render 1.13+ worlds. +Go check out the amazing project for yourself at [Minecraft-Technik-Wiki/BlockMap](https://github.com/Minecraft-Technik-Wiki/BlockMap). + +# What does this container do? + +This image can be used to render a Minecraft map, by just mounting the world folder and an output folder. The container will execute the render tasks and after that it will stop. If you want to automatically render maps every now and then, you can achieve this by using a cronjob or systemd etc.. + +# Usage + +### Quick Start + +*Please **replace the paths** on the left side with your own!* +*They should all point to a directory, where the region files are located (files like **r.0.0.mca**)* + +``` +sudo docker run -d \ + -v /MY-MINECRAFT-PATH/world/region:/blockmap/input/region/ \ + -v /MY-MINECRAFT-PATH/world_nether/:/blockmap/input/DIM1/ \ + -v /MY-MINECRAFT-PATH/world_the_end/:/blockmap/input/DIM-1/ \ + -v /MY-OUTPUT-PATH/output:/opt/blockmap/output \ + --name blockmap \ + saibotk/blockmap +``` + +### BlockMap + Nginx setup + +*Coming soon...* \ No newline at end of file