Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/multipaper/shreddedpaper
Multi-thread, single-server papermc implementation
https://github.com/multipaper/shreddedpaper
Last synced: about 2 months ago
JSON representation
Multi-thread, single-server papermc implementation
- Host: GitHub
- URL: https://github.com/multipaper/shreddedpaper
- Owner: MultiPaper
- License: gpl-3.0
- Created: 2024-05-28T14:15:49.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-09-08T08:43:29.000Z (4 months ago)
- Last Synced: 2024-09-09T07:52:55.458Z (4 months ago)
- Homepage:
- Size: 942 KB
- Stars: 63
- Watchers: 3
- Forks: 7
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# ShreddedPaper
[](https://discord.gg/dN3WCZkSRV)
**ShreddedPaper is in public beta.** Most features work for most players most of
the time, however things can occasionally break.
1.20.6 [Purpur](https://github.com/PurpurMC/Purpur) fork that brings vertical scaling to Minecraft.
ShreddedPaper:
- Allows multiple threads to work together to run a single world
- When ticking a chunk on one thread, all other chunks in a certain radius
are locked so that only this thread has access to them, preventing any
race conditions between threads.
See [HOW_IT_WORKS.md](HOW_IT_WORKS.md) for more information on how ShreddedPaper
works.
### Developing a plugin for a multi-threaded server
In summary, a plugin must be careful of:
- Different threads updating certain data at the same time.
- One thread reading data while it is being updated by another thread.
- Code is to be executed on the chunk's thread, not simply the main thread.
[See here for a more detailed tutorial](DEVELOPING_A_MULTITHREAD_PLUGIN.md)
If your plugin already has support for Folia it is highly likely that it will already work with ShreddedPaper without any changes.
If you have a Folia check similar to the following:
```java
try {
Class.forName("io.papermc.paper.threadedregions.RegionizedServer");
return true;
} catch (ClassNotFoundException e) {
return false;
}
```
You should remove it and instead check of the existence of Paper's region api:
```java
try {
Bukkit.class.getMethod("getRegionScheduler");
return true;
} catch (NoSuchMethodException e) {
return false;
}
```
### Using the ShreddedPaper API as a dependency
[](https://clojars.org/com.github.puregero/shreddedpaper-api)
Add the following into your build.gradle:
```
repositories {
maven {
url "https://repo.clojars.org/"
}
}
dependencies {
compile "com.github.puregero:shreddedpaper-api:1.20.6-R0.1-SNAPSHOT"
}
```
Or in your pom.xml:
```
clojars
https://repo.clojars.org/
com.github.puregero
shreddedpaper-api
1.20.6-R0.1-SNAPSHOT
```
## Building
Requirements:
- You need `git` installed, with a configured user name and email.
On windows you need to run from git bash.
- You need `jdk` 21+ installed to compile (and `jre` 21+ to run)
Build instructions:
1. Patch paper with: `./gradlew applyPatches`
2. Build the shreddedpaper jars with: `./gradlew shadowjar createReobfPaperclipJar`
3. Get the shreddedpaper jar from `build/libs`
## Publishing to maven local
Publish to your local maven repository with: `./gradlew publishToMavenLocal`
Note for mac users: The latest macOS version includes an incompatible version of
diff and you'll need to install a compatible one. Use `brew install diffutils`
to install it, and then reopen the terminal window.
If `diff --version` returns the following, it is incompatible and will not work:
```
Apple diff (based on FreeBSD diff)
```
### Licensing
All code is licensed under [GPLv3](LICENSE.txt).
### Acknowledgements
ShreddedPaper uses PaperMC's paperweight framework found
[here](https://github.com/PaperMC/paperweight).