{"id":42803283,"url":"https://github.com/minehubmc/polarpaper","last_synced_at":"2026-06-17T01:01:36.872Z","repository":{"id":265147008,"uuid":"895268816","full_name":"MinehubMC/PolarPaper","owner":"MinehubMC","description":"Fast and small world format for Paper","archived":false,"fork":false,"pushed_at":"2026-06-01T23:51:08.000Z","size":597,"stargazers_count":40,"open_issues_count":1,"forks_count":13,"subscribers_count":2,"default_branch":"26_1_2","last_synced_at":"2026-06-02T01:20:37.085Z","etag":null,"topics":["minecraft","paper-plugin","spigot-plugin","world-format"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/MinehubMC.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"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,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2024-11-27T22:07:41.000Z","updated_at":"2026-06-01T23:49:04.000Z","dependencies_parsed_at":"2025-05-04T20:27:20.879Z","dependency_job_id":"773696ce-c128-41ae-8215-517c71549a39","html_url":"https://github.com/MinehubMC/PolarPaper","commit_stats":null,"previous_names":["minehubmc/polarpaper"],"tags_count":76,"template":false,"template_full_name":null,"purl":"pkg:github/MinehubMC/PolarPaper","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MinehubMC%2FPolarPaper","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MinehubMC%2FPolarPaper/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MinehubMC%2FPolarPaper/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MinehubMC%2FPolarPaper/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/MinehubMC","download_url":"https://codeload.github.com/MinehubMC/PolarPaper/tar.gz/refs/heads/26_1_2","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MinehubMC%2FPolarPaper/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34429493,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-16T02:00:06.860Z","response_time":126,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["minecraft","paper-plugin","spigot-plugin","world-format"],"created_at":"2026-01-30T03:25:40.570Z","updated_at":"2026-06-17T01:01:36.854Z","avatar_url":"https://github.com/MinehubMC.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# PolarPaper\n#### Polar world format for Paper\n\n\u003e [!WARNING]  \n\u003e Not widely tested, possibly unstable. Backup your worlds before if you don't want to lose them!\n\nPolar is a world format very similar to Slime, with the same advantages:\n - Small file sizes\n - Single file world\n - Immutable (worlds do not save until explicitly requested)\n - Store worlds wherever (whether as a file or in a database)\n\nPolar is also a single plugin without requiring classloaders or a Paper fork\n\n### [Download the latest jar](https://github.com/MinehubMC/PolarPaper/releases/latest)\n\nPolar was originally developed for [Minestom](https://github.com/Minestom/Minestom), see the Minestom library [here](https://github.com/hollow-cube/polar)\n\n[Support Discord](https://discord.gg/n7fp52auB7)\n\n## Permissions\nPermission nodes are simply `polarpaper.\u003csubcommand\u003e`, for example: `polarpaper.info` for `/polar info`\n\n`polarpaper.use` for the root command (/polar)\n\n## Custom gamerules\nPolar provides a few custom gamerules that can be defined in the config:\n| Name          | Type    | Description                                                                                                |\n| ------------- | ------- | ---------------------------------------------------------------------------------------------------------- |\n| blockPhysics  | Boolean | Controls block placement/interaction rules                                                                 |\n| blockGravity  | Boolean | Allow gravity blocks to fall (sand, gravel)                                                                |\n| liquidPhysics | Boolean | Allow lava/water to flow                                                                                   |\n| blockFade     | Boolean | Controls block fading or disappearing (e.g. snow/ice melting, fire burning out, coral death, turtle eggs)  |\n\n# API\nRemember to add `polarpaper` to your depend list in plugin.yml if using as a plugin/compileOnly\n```yml\ndepend:\n  - polarpaper\n```\n\nAdd to Gradle:\n```kts\nrepositories {\n    maven(\"https://repo.minehub.live/releases\")\n}\ndependencies {\n    compileOnly(\"live.minehub:polarpaper:\u003clatest version\u003e\")\n}\n```\n\nLoad a polar world\n```java\n// Manually\nbyte[] bytes = ...\nPolar.createWorld(bytes, worldName);\n// or\nbyte[] bytes = ...\nPolarWorld polarWorld = PolarReader.read(bytes); // (PolarWorld can be reused, see below)\nPolar.createWorld(polarWorld, worldName);\n\n// Using PolarSource\nPath savePath = Path.of(\"./epic/world.polar\");\n// feel free to use your own PolarSource implementation\nPolarSource source = new FilePolarSource(savePath);\nPolar.loadWorld(source, worldName);\n\n// Load world like /polar load - must be in PolarPaper worlds folder\nPolar.loadWorldFromFile(\"gamingworld\");\n```\n\nSave a polar world\n```java\n// Manually\nPolarWorld polarWorld = ...\npolarWorld.updateChunks(bukkitWorld); // update chunks in the polar world\nbyte[] bytes = PolarWriter.write(polarWorld);\n\n// Using PolarSource\nWorld bukkitWorld = player.getWorld();\nPath savePath = Path.of(\"./epic/world.polar\");\n// feel free to use your own PolarSource implementation\nPolarSource source = new FilePolarSource(savePath);\nPolar.saveWorld(bukkitWorld, source);\n\n// Save world like /polar save\nWorld bukkitWorld = player.getWorld();\nPolar.saveWorldToFile(bukkitWorld);\n```\n\nReusing the PolarWorld object\n```java\n// We can save memory and load time by reusing one PolarWorld\nbyte[] bytes = ...\nPolarWorld polarWorld = PolarReader.read(bytes);\nPolar.createWorld(polarWorld, \"worldName1\");\nPolar.createWorld(polarWorld, \"worldName2\");\nPolar.createWorld(polarWorld, \"worldName3\");\n```\n\nGet the `PolarGenerator` of a world\n```java\nWorld world = ... // e.g. player.getWorld()\nPolarGenerator polarGenerator = PolarGenerator.fromWorld(world);\n// (returns null if the world is not from PolarPaper)\n```\n\nPaste a polar world into a world (like a .schematic)\n```java\nPath worldPath = Path.of(\"./epic/world.polar\");\nbyte[] polarBytes = Files.readAllBytes(worldPath);\nPolarWorld polarWorld = PolarReader.read(polarBytes);\nVector3i offset = new Vector3i(x, y, z);\nSetter setter = new Setter.World(player.getWorld());\nSchematic.paste(polarWorld, setter, offset, Rotation.CLOCKWISE_90, Schematic.IgnoreAir.EMPTY_SECTION);\n```\n\nRegister events\n```java\n// If you're not using PolarPaper as a plugin and instead using it exclusively\n// as a dependency (e.g. implementation instead of compileOnly), you do not need to\n// add it to the depend list in your plugin.yml. However, you must manually register the plugin listeners:\nPolarPaper.registerEvents();\n```\n\n### Versioning\n`\u003cmc version\u003e.\u003cour version\u003e`\n\nfor example `1.21.4.1`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fminehubmc%2Fpolarpaper","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fminehubmc%2Fpolarpaper","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fminehubmc%2Fpolarpaper/lists"}