diff --git a/Installation.md b/Installation.md new file mode 100644 index 0000000..eddc3c0 --- /dev/null +++ b/Installation.md @@ -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 `)* +- 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 +... \ No newline at end of file