Upstream/BlueMap
1
0
Fork 0
mirror of https://github.com/BlueMap-Minecraft/BlueMap.git synced 2024-11-25 12:05:13 +01:00
Code Issues Projects Releases Wiki Activity

Created Installation (markdown)

Lukas Rieger 2020-01-08 17:32:32 +01:00
parent 24393147cc
commit 9b92b0c597
1 changed files with 17 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
Installation.md Normal file

@ -0,0 +1,17 @@
# Installation
To run bluemap you need:
- Java 8
- Minecraft Java-Edition
## On the CLI
You can use bluemap as a standalone app using the [CLI](https://en.wikipedia.org/wiki/Command-line_interface). This is useful if you want to render a map of a minecraft-world you have, but don't want to setup a server.
- First you want to download the bluemap-jar. You can choose and download a version from [here](https://github.com/BlueMap-Minecraft/BlueMap/releases). Make sure it targets CLI and is compatible with the minecraft-version of the world you want to render.
- Choose/create a directory where you want bluemap to run and generate it's config and files and store your downloaded jar in this folder.
- Open the CLI and change your [cwd](https://en.wikipedia.org/wiki/Working_directory) to the folder containing your jar. *(using `cd <path-to-your-folder>`)*
- Run `java -jar BlueMap.jar` so bluemap generates the configuration-file *(`./bluemap.conf`)* next to the jar in your cwd.
- Now open the config using your favorite editor and read the chapter [Configuration]() to learn how to configure bluemap.
- After you have edited the config just run `java -jar BlueMap.jar` again to start the render.
## As a sponge-plugin
...