How to install squaremap on your Minecraft server

squaremap makes a flat map of your Minecraft world for players to browse. It needs a port for its built-in web server, which the panel can assign during installation.

Install it from the panel

On a supported release, the panel can install squaremap and set its web port for you.

1. Open your Minecraft server in the control panel, take a backup and stop it.
2. Open Plugins, or Mods on a modded server. Keep Versions on Current version, search for squaremap and click its install icon. Choose a release for your server software and Minecraft version.
3. Leave Configure automatically ticked. Under Port, choose Assign a new port or an unused secondary allocation. Do not use your main Minecraft port or a port already used by another plugin.

   

4. Click Install plugin or Install mod. Once it finishes, start the server and use the web address described below.

If no suitable download or automatic configuration option is offered, use the manual method below. On an installation tracked by the panel, the Change version icon beside its installed JAR opens the configuration options again.

Upload squaremap and set its port manually

1. Stop the server, then choose the correct JAR from squaremap's releases. Use a supported server platform such as Paper, or the matching mod build. A normal Spigot server cannot use a Paper-only release.
2. Open Files in the panel and open plugins. Drag the JAR into File Manager, or use SFTP to upload it to the same folder. Use mods for a mod build and include its listed dependencies, such as Fabric API where required. Start the server once to create the config, then stop it.
3. Open Network and create an extra allocation in Network for the map. Do not share it with Minecraft, voice chat or another web map.
4. In Files, edit plugins/squaremap/config.yml on Paper, or config/squaremap/config.yml on a modded or Sponge server.
5. Find settings, then internal-webserver. Keep it enabled, use 0.0.0.0 for the bind address and replace the port with your Network allocation. For example

   settings:
     internal-webserver:
       enabled: true
       bind: 0.0.0.0
       port: 25582

   

   Edit those existing settings and preserve the rest of the file and its indentation. Changing web-address alone does not change the port the web server listens on.
6. Save the file and start the server.

Open http://YOUR_SERVER_IP:YOUR_SQUAREMAP_PORT/ in a browser. The map may be empty until chunks have been rendered. Run /map help in game for the commands available in your installed version, then use its fullrender command with your world name to render existing terrain.