Installation - jpenilla/squaremap GitHub Wiki

Installation of the plugin is extremely simple.

  1. Download the plugin jar and place it in your server's plugins (Paper, Sponge) or mods directory (Forge, Fabric)
  2. Start your server to let all the default configs and files generate
  3. Edit the configuration to your liking
  4. Stop and start the server to use the edited configurations (a reload might not be sufficient enough depending on the changes you've made, so just do a /stop and start it back up)
  5. Be sure you check the console/logs to ensure everything worked and no errors were present during startup

You can then access the map by going to http://your-ip:port. The port is 8080 by default, but may be different depending on what you set in step 3. Your ip is the ip/domain used to access the server.

⚠️ Note ⚠️
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.

You are now running the map using the built in internal web server. If you already have an external web server (or want to add one) follow the external server instructions.