Add SquareMap to your server

SquareMap allows you and your players to see a simple map of your Minecraft world inside the browser. In this article, we will show you how to configure SquareMap for your exaroton server.

java

Use server software for mods or plugins

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

Install SquareMap and start your server

After setting up your server software, search for "SquareMap" in the mod/plugin browser and install a compatible version. 

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

Configure SquareMap

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

In the config file, set the port to 80 and the web-address to your server address (e.g. https://example.exaroton.me):

settings:
    web-address: https://example.exaroton.me
    internal-webserver:
        port: 80

All other options can remain unchanged.

Restart your server and access your web map

After updating the config file, restart your server to apply the changes. Once your server is running, you can open your web map 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 SquareMap 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.