Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/x4e/paperbin
An experiment at improving the performance of PaperMC
https://github.com/x4e/paperbin
Last synced: about 1 month ago
JSON representation
An experiment at improving the performance of PaperMC
- Host: GitHub
- URL: https://github.com/x4e/paperbin
- Owner: x4e
- License: other
- Created: 2020-04-12T11:26:12.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-05-02T16:37:04.000Z (over 3 years ago)
- Last Synced: 2023-03-11T06:23:54.718Z (almost 2 years ago)
- Language: Kotlin
- Size: 22.4 MB
- Stars: 96
- Watchers: 3
- Forks: 8
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: License.md
Awesome Lists containing this project
README
# PaperBin 🗑️
[](https://github.com/x4e/PaperBin/releases/latest)
[](https://discord.gg/9wA2G8E)
An experiment at improving the performance of PaperMC.
This project uses jvmti to modify Minecraft classes at runtime.
Because of this paperbin can even be run on top of modified versions of paper.
## Donate
You can donate by sending bitcoin to `bc1q35vyw5rudnttchglj3rch9p2j9xxannumn3muv`.
## Usage
Note: It is highly recommended to run PaperBin on Java 15 using ZGC and large pages for best performance.
Download the latest 1.12.2 release from [Paper's website](https://papermc.io/legacy).
Go to [the releases](https://github.com/x4e/PaperBin/releases) and download PaperBin.jar as well as the relevant native library for your platform (dll for windows, dylib for mac, so for linux).
The following commands will be for the linux native library, adapt them for your one.
```
java -jar paper-1.12.2-1618.jar
java -agentpath:libJvmClassHook.so -jar PaperBin.jar cache/patched_1.12.2.jar
```
The first command should exit with an error.
If it does not then quit it yourself once it has finished starting up the server.
## Testomonials
> paperbin
> did lots of impovements to my server
> i can f\*\*\*ing handle 15k entities
> in 4 chunks
> without tps drop
(Kaspian#8508)
> paperbin runs great for a server with 100+ players and wont affect breaking blocks or eating that much when the tps is low would recommend
(cubebuilderunderscore#4344)
> thanks for making such a helpful server tool
(Gav#7669)
## Test Server
This plugin is currently active on `oldfag.org`, feel free to connect and test it out, there are no rules.
## Features:
- Multithreaded mob ai goal calculation
- Anti Chunk Ban
- Anti Crasher (book exploit)
- Anti Dupe (portal entity exploit)
- Anti Elytra Fly (infinite durability exploit)
- Anti Grief (various exploits to break end portals)
- Anti Nether Roof (prevent people glitching above/below bedrock or outside the world border)
- Anti Portal God Mode (exploit allowing invincibility after travelling through a portal)
- Anti Unicode Chat
- Block Tick Rate Limiter (limit the rate at which blocks are ticked)
- Chunk Loading Optimisations (remove some unecessary locks)
- Faster Game Rule Lookups (average O(1) vs original O(n))
- Mob AI Rate Limiting
- Optimised everyone sleeping checks
- Tps Compensation for events such as food/potion consumption, furnace/brewing progress etc
- Village rate limiter (rate limit the rate at which villages are updated)
## Configuration
The first time you run PaperBin it will output the default config to `paperbin.properties`, just replace the defaults as necessary.
## Building
Paperbin needs the patched paper jar as a dependency, so you will need to follow these build steps.
```Bash
git clone https://github.com/x4e/PaperBin
cd PaperBin
mkdir paperbin
wget https://papermc.io/api/v2/projects/paper/versions/1.12.2/builds/1618/downloads/paper-1.12.2-1618.jar -O paperbin/paper.jar
cd paperbin
java -jar paper.jar
cd ../
./build.sh
```
## YourKit
Thank you YourKit for supporting this project with their amazing profiler.
YourKit supports open source projects with innovative and intelligent tools
for monitoring and profiling Java and .NET applications.
YourKit is the creator of [YourKit Java Profiler](https://www.yourkit.com/java/profiler/),
[YourKit .NET Profiler](https://www.yourkit.com/.net/profiler/),
and [YourKit YouMonitor](https://www.yourkit.com/youmonitor/).