https://github.com/jpenilla/squaremap
squaremap is a minimalistic and lightweight world map viewer for Minecraft servers, using the vanilla map rendering style
https://github.com/jpenilla/squaremap
fabric-mod map minecraft-mod minecraft-plugin neoforge-mod paper-plugin sponge-plugin squaremap
Last synced: 20 days ago
JSON representation
squaremap is a minimalistic and lightweight world map viewer for Minecraft servers, using the vanilla map rendering style
- Host: GitHub
- URL: https://github.com/jpenilla/squaremap
- Owner: jpenilla
- License: other
- Created: 2021-12-04T04:17:17.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2025-05-07T01:53:10.000Z (29 days ago)
- Last Synced: 2025-05-07T02:47:26.646Z (29 days ago)
- Topics: fabric-mod, map, minecraft-mod, minecraft-plugin, neoforge-mod, paper-plugin, sponge-plugin, squaremap
- Language: Java
- Homepage: https://modrinth.com/plugin/squaremap
- Size: 5.46 MB
- Stars: 392
- Watchers: 4
- Forks: 48
- Open Issues: 56
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-minecraft - squaremap - squaremap is a minimalistic and lightweight world map viewer for Minecraft servers, using the vanilla map rendering style. (Maps)
README
# squaremap
[](LICENSE)
[](https://github.com/jpenilla/squaremap/actions)
[](https://discord.gg/PHpuzZS)
## 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/)
- [Fabric](https://fabricmc.net/) (requires [Fabric API](https://modrinth.com/mod/fabric-api))
- [NeoForge](https://neoforged.net/)
- [Sponge](https://www.spongepowered.org/)
## Downloads
Downloads can be obtained from the [releases](https://github.com/jpenilla/squaremap/releases) section.
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.
### Dependency Information
Releases are published to Maven Central
Using snapshot builds
> Snapshot builds are available on the Sonatype snapshots maven repository: `https://s01.oss.sonatype.org/content/repositories/snapshots/`
>
> Consult your build tool's documentation for details on adding maven repositories to your project.
Maven
```xml
xyz.jpenilla
squaremap-api
1.3.5
provided
```
Gradle
```kotlin
repositories {
mavenCentral()
}
dependencies {
compileOnly("xyz.jpenilla", "squaremap-api", "1.3.5")
}
```
## Develop
### Prerequisites and setup
- An up-to date JDK (i.e. Java 21 or later)
- [Bun](https://bun.sh/) installed for building the web UI
- Run `bun install` in the `web` directory to install the web UI dependencies
### Plugin
Build squaremap by invoking the `build` task with Gradle.
```
./gradlew build
```
### Web UI
The web UI will be automatically built and included in the plugin jar by Gradle when building the plugin.
When using the various run tasks (i.e. `:squaremap-paper:runServer`), Gradle will pass the
`squaremap.devFrontend=true` and `squaremap.frontendPath=` system properties to
the server. When these properties are present, the plugin will attempt to run the Vite dev server and
proxy requests to it. This allows hot module reloading to work when developing the web UI.
## bStats
Usage stats for the Paper platform
[](https://bstats.org/plugin/bukkit/squaremap/13571)