How to Set Up squaremap on a Minecraft Java Edition Server

squaremap creates a minimalistic 2D web map of your Minecraft server. The map is rendered in vanilla style and can be opened directly in a browser.

Step 1: Install the Plugin

1. Download plugin
   Download squaremap for your server version and place the .jar file into the plugins folder.

2. Restart server
   Restart your server so the config files are created.

Step 2: Open a Port

1. Open network section
   Open the Network section in your dashboard. There you will find an overview of all available ports.

2. Choose a port
   Choose an available port and note it down.

Step 3: Configure the Config File

1. Open config file
   Open the file plugins/squaremap/config.yml.

2. Find port section
   Look for the internal-webserver section:

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

3. Replace port
   Replace 8080 with your chosen port from Step 2.

4. Save changes
   Save the file.

Step 4: Restart the Server

1. Restart server
   Restart your server for the changes to take effect.

2. Open the map
   Open the web map in your browser at:

   http://YOUR_SERVER_IP:YOUR_PORT