https://github.com/crosbymichael/mc-overviewer-docker
Minecraft overviewer dockerfile
https://github.com/crosbymichael/mc-overviewer-docker
Last synced: 3 months ago
JSON representation
Minecraft overviewer dockerfile
- Host: GitHub
- URL: https://github.com/crosbymichael/mc-overviewer-docker
- Owner: crosbymichael
- Created: 2015-02-07T21:06:27.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2017-06-25T18:36:24.000Z (almost 8 years ago)
- Last Synced: 2024-12-30T01:20:02.059Z (5 months ago)
- Size: 3.91 KB
- Stars: 7
- Watchers: 2
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Minecraft Overviewer
Generate a Google Maps like map of your minecraft world. Documentation for overview can be
found [here](http://overviewer.org/).
## Usage
This Dockerfile requires two volumes owned by UID:GID 1 ( default ). One volume must be mounted
under `/minecraft` which contains a world directory for the world that you wish to create a
map of. The other is the output directory that will contain the generated map mounted under
`/mcmap`.
You will need a config file in the minecraft server root named `overviewer.cfg` where you can specify
any processing options. The config file should have at least 2 lines defining the worlds directory
as well as the output directory. An example overviewer.cfg is:
```
worlds["survival"] = "/minecraft/world"
outputdir = "/mcmap"
```
In addition to the basic map generation, this docker will run twice. The first pass generates the map
while the second pass will read through the config for any POIs defined (Players, signs, towns, etc...)
Here is an example of running Overviewer:
```bash
docker run -ti --rm -v /volumes/mc-web-output:/mcmap -v /volumes/minecraft-server-root:/minecraft:ro overviewer
```
It is recommended that you mount your minecraft world as `ro` so that you can ensure overviewer does
not modify any files and this can be done on a running minecraft server.
After the execution is complete, a full map with an index.html file will be generated in the path used
for `/mcmap`.