How to Set Up squaremap on a Minecraft Java 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.
Warning
squaremap requires its own port for the web server. Do not use your server's default port!
Note
squaremap only works with Paper or Purpur servers. It does not run on Vanilla, Spigot, Forge or Fabric servers.
Step 1: Install the Plugin
Download plugin
Download squaremap for your server version and place the.jarfile into thepluginsfolder.Restart server
Restart your server so the config files are created.
Step 2: Open a Port
Open network section
Open the Network section in your dashboard. There you will find an overview of all available ports.Choose a port
Choose an available port and note it down.
Important
Do not use your server's default port! squaremap requires a separate port.
Step 3: Configure the Config File
Open config file
Open the fileplugins/squaremap/config.yml.Find port section
Look for theinternal-webserversection:yamlsettings: internal-webserver: enabled: true bind: 0.0.0.0 port: 8080settings: internal-webserver: enabled: true bind: 0.0.0.0 port: 8080Replace port
Replace8080with your chosen port from Step 2.Save changes
Save the file.
Step 4: Restart the Server
Restart server
Restart your server for the changes to take effect.Open the map
Open the web map in your browser at:http://YOUR_SERVER_IP:YOUR_PORThttp://YOUR_SERVER_IP:YOUR_PORT