squaremap

# squaremap ## What is squaremap squaremap is a minimalistic and lightweight live world map viewer for Minecraft servers. squaremap hooks into your Minecraft server as a plugin or mod on a [supported platform](#supported-platforms), then generates and manages a live map of your server, viewable in any web browser. ## Features * Ultra fast render times. Get your map rendered today, not next week. * Simple vanilla-like top down 2D view, designed for navigation. * Player markers showing yaw rotation, health, and armor. * Easy to [setup](https://github.com/jpenilla/squaremap/wiki/Installation) and [configure](https://github.com/jpenilla/squaremap/wiki/Default-config.yml). * Up to date Leaflet front-end. * [Addons and integrations](https://github.com/jpenilla/squaremap/wiki/Addons) for many popular plugins. ## Supported platforms - [Paper](https://papermc.io/) - [Sponge](https://www.spongepowered.org/) - [Fabric](https://fabricmc.net/) (requires [Fabric API](https://www.curseforge.com/minecraft/mc-mods/fabric-api)) - [NeoForge](https://neoforged.net/) ## Downloads Downloads can be obtained here on Modrinth, or from [GitHub releases](https://github.com/jpenilla/squaremap/releases) for all supported platforms. Development builds > Development builds are available at https://jenkins.jpenilla.xyz/job/squaremap/ ## Demo Official squaremap demo: https://squaremap-demo.jpenilla.xyz/ ## License This project is licensed under the [MIT license](https://github.com/jpenilla/squaremap/blob/master/LICENSE) Leaflet (the web ui frontend) is licensed under [2-clause BSD License](https://github.com/Leaflet/Leaflet/blob/master/LICENSE) ## API squaremap provides simple APIs to draw markers, shapes, icons, and etc. on rendered maps. Javadocs are hosted on the maven repository alongside the binaries, and should be automatically downloaded by your IDE. See the [README](https://github.com/jpenilla/squaremap/blob/master/README.md) and [Wiki](https://github.com/jpenilla/squaremap/wiki) for more details about the API.