Upstream/BlueMap
1
0
Fork 0
mirror of https://github.com/BlueMap-Minecraft/BlueMap.git synced 2024-11-22 10:35:16 +01:00
Code Issues Projects Releases Wiki Activity

Updated Installation (markdown)

Lukas Rieger 2020-08-21 21:14:13 +02:00
parent 066ce9b6b3
commit 4195e338c1
1 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
Installation.md

@ -2,16 +2,6 @@ To run bluemap you need:
- Java 8 or newer - Java 8 or newer
- Minecraft Java-Edition - 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](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 ## As a sponge-plugin
If you have a [sponge](https://www.spongepowered.org/)-server, you can use bluemap as a plugin on your server. The plugin then renders and actively updates your map when something changes. Render-tasks are paused and resumed if the server shuts down / restarts. If you have a [sponge](https://www.spongepowered.org/)-server, you can use bluemap as a plugin on your server. The plugin then renders and actively updates your map when something changes. Render-tasks are paused and resumed if the server shuts down / restarts.
@ -38,4 +28,14 @@ If you have a [forge](https://minecraftforge.net/) or [fabric](https://fabricmc.
- Put the downloaded bluemap-jar in the `mods`-folder of your server and restart the server. - Put the downloaded bluemap-jar in the `mods`-folder of your server and restart the server.
- BlueMap will now generate the configuration file here `./config/bluemap/bluemap.conf`, open that config with your favorite editor and read the chapter [Configuration](Configuration) to learn how to configure bluemap. - BlueMap will now generate the configuration file here `./config/bluemap/bluemap.conf`, open that config with your favorite editor and read the chapter [Configuration](Configuration) to learn how to configure bluemap.
- After you have edited the config use the command `/bluemap reload` on your server or restart the server. - After you have edited the config use the command `/bluemap reload` on your server or restart the server.
- Run the command `/bluemap render <world>` on the server to start an initial render of the whole world. - Run the command `/bluemap render <world>` on the server to start an initial render of the whole world.
## On the CLI / standalone (WIP)
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](Configuration) to learn how to configure bluemap.
- After you have edited the config just run `java -jar BlueMap.jar` again to start the render.