{"id":19468178,"url":"https://github.com/multipaper/shreddedpaper","last_synced_at":"2025-02-25T14:24:18.478Z","repository":{"id":241589636,"uuid":"807119590","full_name":"MultiPaper/ShreddedPaper","owner":"MultiPaper","description":"Multi-thread, single-server papermc implementation","archived":false,"fork":false,"pushed_at":"2024-09-08T08:43:29.000Z","size":965,"stargazers_count":80,"open_issues_count":8,"forks_count":6,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-01-08T04:38:12.124Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/MultiPaper.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","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}},"created_at":"2024-05-28T14:15:49.000Z","updated_at":"2024-12-24T14:05:59.000Z","dependencies_parsed_at":"2024-05-30T10:22:52.892Z","dependency_job_id":"5b4dfd61-b16e-4a25-a401-b01f868e4722","html_url":"https://github.com/MultiPaper/ShreddedPaper","commit_stats":null,"previous_names":["multipaper/shreddedpaper"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MultiPaper%2FShreddedPaper","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MultiPaper%2FShreddedPaper/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MultiPaper%2FShreddedPaper/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MultiPaper%2FShreddedPaper/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/MultiPaper","download_url":"https://codeload.github.com/MultiPaper/ShreddedPaper/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240681963,"owners_count":19840421,"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":[],"created_at":"2024-11-10T18:39:08.786Z","updated_at":"2025-02-25T14:24:18.447Z","avatar_url":"https://github.com/MultiPaper.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# ShreddedPaper\n\n[![Discord](https://img.shields.io/discord/937309618743427113.svg?color=738ad6\u0026label=Join%20the%20Discord%20server\u0026logo=discord\u0026logoColor=ffffff)](https://discord.gg/dN3WCZkSRV)\n\n**ShreddedPaper is in public beta.** Most features work for most players most of\nthe time, however things can occasionally break.\n\n1.20.6 [Purpur](https://github.com/PurpurMC/Purpur) fork that brings vertical scaling to Minecraft.\n\nShreddedPaper:\n\n- Allows multiple threads to work together to run a single world\n  - When ticking a chunk on one thread, all other chunks in a certain radius\n    are locked so that only this thread has access to them, preventing any\n    race conditions between threads.\n\nSee [HOW_IT_WORKS.md](HOW_IT_WORKS.md) for more information on how ShreddedPaper\nworks.\n\n### Developing a plugin for a multi-threaded server\n\nIn summary, a plugin must be careful of:\n\n- Different threads updating certain data at the same time.\n- One thread reading data while it is being updated by another thread.\n- Code is to be executed on the chunk's thread, not simply the main thread.\n\n[See here for a more detailed tutorial](DEVELOPING_A_MULTITHREAD_PLUGIN.md)\n\nIf your plugin already has support for Folia it is highly likely that it will already work with ShreddedPaper without any changes.  \nIf you have a Folia check similar to the following:  \n```java\ntry {\n    Class.forName(\"io.papermc.paper.threadedregions.RegionizedServer\");\n    return true;\n} catch (ClassNotFoundException e) {\n    return false;\n}\n```\nYou should remove it and instead check of the existence of Paper's region api:  \n```java\ntry {\n    Bukkit.class.getMethod(\"getRegionScheduler\");\n    return true;\n} catch (NoSuchMethodException e) {\n    return false;\n}\n```\n\n### Using the ShreddedPaper API as a dependency\n\n[![Clojars Project](https://img.shields.io/clojars/v/com.github.puregero/shreddedpaper-api.svg)](https://clojars.org/com.github.puregero/shreddedpaper-api)\n\nAdd the following into your build.gradle:\n\n```\nrepositories {\n  maven {\n    url \"https://repo.clojars.org/\"\n  }\n}\n\ndependencies {\n  compile \"com.github.puregero:shreddedpaper-api:1.20.6-R0.1-SNAPSHOT\"\n}\n```\n\nOr in your pom.xml:\n\n```\n\u003crepositories\u003e\n    \u003crepository\u003e\n        \u003cid\u003eclojars\u003c/id\u003e\n        \u003curl\u003ehttps://repo.clojars.org/\u003c/url\u003e\n    \u003c/repository\u003e\n\u003c/repositories\u003e\n\u003cdependencies\u003e\n    \u003cdependency\u003e\n        \u003cgroupId\u003ecom.github.puregero\u003c/groupId\u003e\n        \u003cartifactId\u003eshreddedpaper-api\u003c/artifactId\u003e\n        \u003cversion\u003e1.20.6-R0.1-SNAPSHOT\u003c/version\u003e\n    \u003c/dependency\u003e\n\u003c/dependencies\u003e\n```\n\n## Building\nRequirements:\n- You need `git` installed, with a configured user name and email. \n   On windows you need to run from git bash.\n- You need `jdk` 21+ installed to compile (and `jre` 21+ to run)\n\nBuild instructions:\n1. Patch paper with: `./gradlew applyPatches`\n2. Build the shreddedpaper jars with: `./gradlew shadowjar createReobfPaperclipJar`\n3. Get the shreddedpaper jar from `build/libs`\n\n## Publishing to maven local\nPublish to your local maven repository with: `./gradlew publishToMavenLocal`\n\nNote for mac users: The latest macOS version includes an incompatible version of\ndiff and you'll need to install a compatible one. Use `brew install diffutils`\nto install it, and then reopen the terminal window.\n\nIf `diff --version` returns the following, it is incompatible and will not work:\n```\nApple diff (based on FreeBSD diff)\n```\n\n### Licensing\n\nAll code is licensed under [GPLv3](LICENSE.txt).\n\n### Acknowledgements\n\nShreddedPaper uses PaperMC's paperweight framework found\n[here](https://github.com/PaperMC/paperweight).","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmultipaper%2Fshreddedpaper","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmultipaper%2Fshreddedpaper","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmultipaper%2Fshreddedpaper/lists"}