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-26 01:11:29 +02:00
parent 20b7657c59
commit 1009f9fbaf
1 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
Installation.md

@ -7,8 +7,8 @@ If you have a [sponge](https://www.spongepowered.org/)-server, you can use bluem
- First you want to download the bluemap-jar. You can choose and download a version from [here](https://github.com/BlueMap-Minecraft/BlueMap/releases) or from [sponges plugin-repository](https://ore.spongepowered.org/Blue/BlueMap). Make sure it targets the SpongeAPI-Version of your 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) or from [sponges plugin-repository](https://ore.spongepowered.org/Blue/BlueMap). Make sure it targets the SpongeAPI-Version of your server!
- Put the downloaded jar in the `mods`-folder of your server and restart the server. - Put the downloaded 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 files here `./config/bluemap/`, open those configs 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 configs 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.
## As a spigot/paper-plugin ## As a spigot/paper-plugin
@ -16,8 +16,8 @@ If you have a [spigot](https://www.spigotmc.org/) or [paper](https://papermc.io/
- 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 the SpigotAPI-Version of your 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 the SpigotAPI-Version of your server!
- Put the downloaded jar in the `plugins`-folder of your server and restart the server. - Put the downloaded jar in the `plugins`-folder of your server and restart the server.
- BlueMap will now generate the configuration file here `./plugins/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 files here `./plugins/bluemap/`, open those configs 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 configs 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.
## As a forge/fabric-mod ## As a forge/fabric-mod
@ -26,8 +26,8 @@ If you have a [forge](https://minecraftforge.net/) or [fabric](https://fabricmc.
- 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 the forge/fabric-Version of your 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 the forge/fabric-Version of your server!
- If you have a fabric-server you will also need to install the [fabricAPI](https://www.curseforge.com/minecraft/mc-mods/fabric-api) mod. - If you have a fabric-server you will also need to install the [fabricAPI](https://www.curseforge.com/minecraft/mc-mods/fabric-api) mod.
- 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 files here `./config/bluemap/`, 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 configs 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) ## On the CLI / standalone (WIP)
@ -36,6 +36,6 @@ You can use bluemap as a standalone app using the [CLI](https://en.wikipedia.org
- 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. - 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. - 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>`)* - 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. - Run `java -jar BlueMap-cli.jar` so bluemap generates the configuration-files 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. - Now open the configs 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. - After you have edited the configs run `java -jar BlueMap-cli.jar -r` to start the render.