Minecraft plugin squaremap

🔌 About the plugin squaremap

squaremap — is a plugin for Minecraft servers that allows generation and hosting of a lightweight, vanilla‑style live 2D world map viewable in a web browser.

🎯 Purpose

squaremap addresses the need for a fast, low‑impact web map for Minecraft servers. It provides a responsive top‑down 2D map intended for navigation and monitoring without heavy resource cost.

• Target problems solved by squaremap:
  • Provide a live visual map for players and staff
  • Reduce map generation time compared to long full renders
  • Offer a simple API for addons and integrations

⚙ Main features

• Ultra‑fast rendering and low server impact.
• Vanilla‑style top‑down 2D map tiles and player markers (yaw, health, armor).
• Web frontend built with Leaflet (kept up to date).
• Addons and integrations API for other plugins.
• Releases published to Maven Central (API artifacts available).
• Official demo instance and development builds available.

🧩 Who is it for

squaremap is suitable for:

• Paper‑based Minecraft servers that want a lightweight web map.
• Servers using Fabric (Fabric API required) that prefer a map mod.
• Network administrators who need an API for markers and integrations.
• Communities that need a clean vanilla look rather than heavy 3D rendering.

🏗 Usage examples

• Run squaremap on a Paper server to host a live navigation map for players.
• Integrate an addon to draw faction regions, town boundaries or custom markers via the squaremap API.
• Use the demo/frontend to embed a server map into a site for players.

⚡ Verified characteristics

• Supported platforms: Paper, Fabric (requires Fabric API), NeoForge, Sponge. (Confirmed in the project README.)
• bStats: usage stats for the Paper platform are present in the project resources. (Confirmed in README.)
• Addons & API: squaremap exposes a simple API for markers, shapes and icons; addons exist. (Confirmed in README and project wiki.)

⌨️ Commands

The plugin's official README does not list in‑game commands. The plugin's public documentation and repository (README and Wiki) do not provide authoritative command tables. Therefore:

The plugin does not add new commands (no confirmed commands in official sources).

🔐 Permissions

Information about specific permission nodes for squaremap is not present in the official README or primary project documentation that is publicly listed. Do not assume permissions — consult the plugin jar or repository plugin.yml for authoritative permission nodes.

⚙ Installation

📥 Installation

• Download the appropriate build (.jar) from the project's releases (official releases or development builds).
• Place the .jar into your server's plugins/ (or mods/ for Fabric if using a mod build).
• Fully restart the server (do not rely on /reload).
• Verify the plugin/web UI started by checking server console and the web frontend (demo available).

📦 Dependencies

• Fabric platform requires Fabric API (explicitly confirmed).
• No other mandatory dependencies are listed in the official README. (Do not assume Vault/PlaceholderAPI etc. unless your use case or addon requires them.)

🧾 Configuration

• Official sources confirm the project provides a web frontend bundled when built with Gradle, but explicit details about generated config.yml or database backends are not stated in the README. Configuration and addon settings are documented in the project wiki and repository — consult the repository for config examples.
• Information about MySQL/SQLite support is not documented in the main README.

🧠 Additional information

• Known conflicts: Official README does not list specific plugin conflicts. Test in staging if combining with other map or rendering systems.
• Limitations: squaremap focuses on 2D vanilla‑style mapping rather than 3D visualization; it aims for low server impact.
• FAQ (short):
  1. Does squaremap work on Paper? — Yes, Paper is a supported platform. (Confirmed.)
  2. Does Fabric require anything extra? — Fabric builds require the Fabric API. (Confirmed.)
  3. Does the project collect metrics? — The README references bStats usage for the Paper platform. (Confirmed.)
  4. Are there official addons? — The project documents addons and provides an API for integrations; several community addons exist. (Confirmed in README/wiki.)
• Support & resources: the project repository provides the README, wiki, releases and a demo frontend. For issues and feature requests use the repository issue tracker.

Notes: This description uses only information confirmed in the project's official README and repository resources. Where the README or wiki did not specify details (commands, specific permission nodes, config generation, database backends), the text explicitly notes that official information is not present and recommends consulting the repository/plugin.yml or testing on a staging server.