{"id":13775373,"url":"https://github.com/jpenilla/squaremap","last_synced_at":"2025-05-15T12:03:35.647Z","repository":{"id":37016201,"uuid":"434804311","full_name":"jpenilla/squaremap","owner":"jpenilla","description":"squaremap is a minimalistic and lightweight world map viewer for Minecraft servers, using the vanilla map rendering style","archived":false,"fork":false,"pushed_at":"2025-05-07T01:53:10.000Z","size":5724,"stargazers_count":392,"open_issues_count":56,"forks_count":48,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-05-07T02:47:26.646Z","etag":null,"topics":["fabric-mod","map","minecraft-mod","minecraft-plugin","neoforge-mod","paper-plugin","sponge-plugin","squaremap"],"latest_commit_sha":null,"homepage":"https://modrinth.com/plugin/squaremap","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jpenilla.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"github":"jpenilla"}},"created_at":"2021-12-04T04:17:17.000Z","updated_at":"2025-05-06T01:56:06.000Z","dependencies_parsed_at":"2023-02-12T20:32:22.451Z","dependency_job_id":"99a349cc-8d09-4e07-a971-994a1825abd3","html_url":"https://github.com/jpenilla/squaremap","commit_stats":{"total_commits":841,"total_committers":43,"mean_commits":"19.558139534883722","dds":"0.43043995243757427","last_synced_commit":"258cc9d991ba9bd459f33d8d1bb3bc528b0f94a1"},"previous_names":[],"tags_count":31,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jpenilla%2Fsquaremap","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jpenilla%2Fsquaremap/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jpenilla%2Fsquaremap/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jpenilla%2Fsquaremap/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jpenilla","download_url":"https://codeload.github.com/jpenilla/squaremap/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254337612,"owners_count":22054253,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["fabric-mod","map","minecraft-mod","minecraft-plugin","neoforge-mod","paper-plugin","sponge-plugin","squaremap"],"created_at":"2024-08-03T17:01:37.677Z","updated_at":"2025-05-15T12:03:35.578Z","avatar_url":"https://github.com/jpenilla.png","language":"Java","readme":"\u003cdiv align=\"center\"\u003e\n\n# squaremap\n\n[![License](https://img.shields.io/badge/license-MIT-blue)](LICENSE)\n[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/jpenilla/squaremap/build.yml?branch=master)](https://github.com/jpenilla/squaremap/actions)\n[![Discord](https://img.shields.io/discord/390942438061113344?color=8C9CFE\u0026label=discord\u0026logo=discord\u0026logoColor=white)](https://discord.gg/PHpuzZS)\n\n\u003c/div\u003e\n\n## What is squaremap\n\nsquaremap is a minimalistic and lightweight live world map viewer for Minecraft servers.\n\nsquaremap 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.\n\n## Features\n\n* Ultra fast render times. Get your map rendered today, not next week.\n* Simple vanilla-like top down 2D view, designed for navigation.\n* Player markers showing yaw rotation, health, and armor.\n* Easy to [setup](https://github.com/jpenilla/squaremap/wiki/Installation) and [configure](https://github.com/jpenilla/squaremap/wiki/Default-config.yml).\n* Up to date Leaflet front-end.\n* [Addons and integrations](https://github.com/jpenilla/squaremap/wiki/Addons) for many popular plugins.\n\n## Supported platforms\n\n- [Paper](https://papermc.io/)\n- [Fabric](https://fabricmc.net/) (requires [Fabric API](https://modrinth.com/mod/fabric-api))\n- [NeoForge](https://neoforged.net/)\n- [Sponge](https://www.spongepowered.org/)\n\n## Downloads\n\nDownloads can be obtained from the [releases](https://github.com/jpenilla/squaremap/releases) section.\n\n\u003cdetails\u003e\n\u003csummary\u003eDevelopment builds\u003c/summary\u003e\n\n\u003e Development builds are available at https://jenkins.jpenilla.xyz/job/squaremap/\n\u003c/details\u003e\n\n## Demo\n\nOfficial squaremap demo: https://squaremap-demo.jpenilla.xyz/\n\n## License\n\nThis project is licensed under the [MIT license](https://github.com/jpenilla/squaremap/blob/master/LICENSE)\n\nLeaflet (the web ui frontend) is licensed under [2-clause BSD License](https://github.com/Leaflet/Leaflet/blob/master/LICENSE)\n\n## API\n\nsquaremap 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. \n\n### Dependency Information\n\nReleases are published to Maven Central\n\n\u003cdetails\u003e\n\u003csummary\u003eUsing snapshot builds\u003c/summary\u003e\n\n\u003e Snapshot builds are available on the Sonatype snapshots maven repository: `https://s01.oss.sonatype.org/content/repositories/snapshots/`\n\u003e\n\u003e Consult your build tool's documentation for details on adding maven repositories to your project.\n\u003c/details\u003e\n\nMaven\n```xml\n\u003cdependency\u003e\n    \u003cgroupId\u003exyz.jpenilla\u003c/groupId\u003e\n    \u003cartifactId\u003esquaremap-api\u003c/artifactId\u003e\n    \u003cversion\u003e1.3.5\u003c/version\u003e\n    \u003cscope\u003eprovided\u003c/scope\u003e\n\u003c/dependency\u003e\n```\n\nGradle\n```kotlin\nrepositories {\n    mavenCentral()\n}\n\ndependencies {\n    compileOnly(\"xyz.jpenilla\", \"squaremap-api\", \"1.3.5\")\n}\n```\n\n## Develop\n\n### Prerequisites and setup\n- An up-to date JDK (i.e. Java 21 or later)\n- [Bun](https://bun.sh/) installed for building the web UI\n- Run `bun install` in the `web` directory to install the web UI dependencies\n\n### Plugin\n\nBuild squaremap by invoking the `build` task with Gradle.\n\n```\n./gradlew build\n```\n\n### Web UI\n\nThe web UI will be automatically built and included in the plugin jar by Gradle when building the plugin.\n\nWhen using the various run tasks (i.e. `:squaremap-paper:runServer`), Gradle will pass the\n`squaremap.devFrontend=true` and `squaremap.frontendPath=\u003cabsolute path to ./web\u003e` system properties to\nthe server. When these properties are present, the plugin will attempt to run the Vite dev server and\nproxy requests to it. This allows hot module reloading to work when developing the web UI.\n\n## bStats\n\nUsage stats for the Paper platform\n\n[![bStats Graph Data](https://bstats.org/signatures/bukkit/squaremap.svg)](https://bstats.org/plugin/bukkit/squaremap/13571)\n","funding_links":["https://github.com/sponsors/jpenilla"],"categories":["Maps"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjpenilla%2Fsquaremap","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjpenilla%2Fsquaremap","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjpenilla%2Fsquaremap/lists"}