Add BlueMap to your server

BlueMap allows you and your players to see an advanced 3D map of your Minecraft world inside the browser. In this article, we will show you how to configure BlueMap for your exaroton server.

java

Alternative maps

The setup for BlueMap on exaroton is a bit more complicated than for most mods/plugins and involves changing multiple configuration files. If you only need a simple map of your world, using SquareMap instead can be easier.

Use server software for mods or plugins

To install BlueMap, you first need to switch to server software that supports installing mods or plugins. BlueMap exists both as a mod (Fabric/Forge/NeoForge) and as a plugin (Spigot/PaperMC), so you can choose whatever fits your needs better.

Install BlueMap and start your server

After setting up your server software, download a compatible version of BlueMap and upload it to your mods/plugins folder. If you are using the Fabric version of BlueMap, you also need to install Fabric API.

BlueMap downloads are available on Modrinth: https://modrinth.com/plugin/bluemap

You can then start your server, which will automatically create the BlueMap config file.

Configure BlueMap

For BlueMap to work on exaroton, you need to configure it correctly. The location of the config folder depends on whether you are using it as a plugin (Spigot/PaperMC) or as a mod (Fabric/Forge/NeoForge):

All the following configuration steps use this config folder as a base.

Allow asset downloads

To correctly render your world in a web browser, BlueMap needs to download Minecraft assets. To allow this, open core.conf and change accept-download to true.

Configuring storage

BlueMap's default file system storage can cause issues on exaroton, which is why data should be stored in an SQLite database instead.

First, open storages/sql.conf and change connection-url to "jdbc:sqlite:bluemap/sqlite.db" and max-connections to 1.

Then, open the maps folder in the BlueMap config folder, edit each of the files in the folder, and change storage to "sql". The option may be further down in the file, but you can use the search function (Ctrl+F) to find it quickly.

Install the SQLite driver

If you are not using PaperMC, you will also need to install an SQLite driver on your server, which you can download from Modrinth: https://modrinth.com/discover/mods?q=jdbc+sqlite 

PaperMC has a built-in SQLite driver, so this step is not needed if you are using PaperMC.

Configuring the correct port

To make BlueMap use the correct port for its web map, open webserver.conf and change port to 80.

Restart your server and open BlueMap

After updating the config files, restart your server to apply the changes. Once your server is running, you can open BlueMap by entering your server address (e.g. example.exaroton.me) in your browser. You can also share this address with your players. 

It might take a few minutes until the map is ready after installing BlueMap for the first time. If the map is still empty, try walking around on your server to load some chunks.

Please note:

Web maps at exaroton only work if the server is running. If your server is not online, the web map will not be available.