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

Updated Installation (markdown)

Lukas Rieger 2020-08-15 15:31:39 +02:00
parent ea7a60daa0
commit 5faaa118a1
1 changed files with 15 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
Installation.md

@ -17,15 +17,25 @@ 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 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.
## As a bukkit/spigot-plugin ## As a spigot/paper-plugin
If you have a [spigot](https://www.spigotmc.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 [spigot](https://www.spigotmc.org/) or [paper](https://papermc.io/)-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.
- 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 BukkitAPI-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 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.
- 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.
## As a forge/fabric-mod
If you have a [forge](https://minecraftforge.net/) or [fabric](https://fabricmc.net/)-server, you can use bluemap as a mod on your server. The mod then renders and actively updates your map when something changes. Render-tasks are paused and resumed if the server shuts down / restarts.
- 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.
- 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.
- 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.