Installation

Installing LiveMap is quite easy.

1. Download the zip and place it in your server's Mods/ directory.
2. (Re)start your server to let the default config and web files generate.
3. Edit the ModConfig/livemap.json file to your liking.
4. Be sure to check console/logs to ensure everything worked without error.
5. Make sure you do whatever you have to do to make your map accessible on the port you specified.

⚠️ ${\text{Note}}$ ⚠️
LiveMap uses port 8080 by default, this can be changed in the livemap.json file. Some server hosts may have port restrictions. It is up to you to contact your host to find out what ports you have available to you.

Congratulations! LiveMap is now installed on your server \o/

You might notice that your map is empty (blue background) at this point, and this is normal. The server needs an admin to do a couple of things before you start to see some map tiles.

1. Install LiveMap on your client and run the /livemap colormap command to generate a colormap.
2. You can now start a fullrender with the /livemap fullrender command.

The fullrender may take a while depending on the size of your world, so be patient. You can enable debug logs in the livemap.json config if you'd like to watch the progress, or use the /livemap status command.

You are now running the map using the built-in Internal Server. If you already have an external web server (or want to add one) follow the External Server instructions. It is also possible to run both using an external server to Reverse Proxy the internal server.