mirror of
https://github.com/PaperMC/Paper.git
synced 2024-11-22 10:35:38 +01:00
High performance Spigot fork that aims to fix gameplay and mechanics inconsistencies
bukkitcraftbukkithacktoberfestjavaminecraftminecraft-apiminecraft-performanceminecraft-serverpaperpaper-apipapermcspigot-forktacos
e6faa36eb9
Mojang precaches every single potential rewrite rule that could ever exist on server startup. This includes rules from all the way back to versions from 6+ years ago. This is the source of why the server hogs every CPU core at 100% every start. For anyone who hard resets for updates or has force upgraded their entire world, this results in completely wasted cpu cycles. This massive CPU usage also delays server startup time. We improve this by making "min version to precache" that defaults to a future version so that no rewrite rules are precached. someone who expects to be converting a lot chunks could theoretically set -DPaper.minPrecachedDatafixVersion=<dataVersionConvertingFrom> as a startup parameter and only build from that point on. However this will likely never be needed as the server will still run the same cache logic on demand when it's actually needed. The only cost would be some delay on the FIRST chunk conversion, but paper already runs chunk conversions on another thread so this will likely never be a concern for TPS. This patch will significantly reduce CPU use on startup, reduce memory usage, and improve server startup time. |
||
|---|---|---|
| .github | ||
| licenses | ||
| Paper-MojangAPI | ||
| removed | ||
| scripts | ||
| Spigot-API-Patches | ||
| Spigot-Server-Patches | ||
| work | ||
| .editorconfig | ||
| .gitignore | ||
| .gitmodules | ||
| .travis.yml | ||
| CONTRIBUTING.md | ||
| LICENSE.md | ||
| paper | ||
| pom.xml | ||
| README.md | ||
| SHIT_TO_CHECK.md | ||
Paper 
High performance Spigot fork that aims to fix gameplay and mechanics inconsistencies.
Support and Project Discussion:
How To (Server Admins)
Paperclip is a jar file that you can download and run just like a normal jar file.
Download Paper from our downloads page.
Run the Paperclip jar directly from your server. Just like old times
- Documentation on using Paper: paper.readthedocs.io
- For a sneak peak on upcoming features, see here
How To (Plugin Developers)
- See our API patches here
- See upcoming, pending, and recently added API here
- Paper API javadocs here: papermc.io/javadocs
- Maven Repo (for paper-api):
<repository>
<id>papermc</id>
<url>https://papermc.io/repo/repository/maven-public/</url>
</repository>
- Artifact Information:
<dependency>
<groupId>com.destroystokyo.paper</groupId>
<artifactId>paper-api</artifactId>
<version>1.16.2-R0.1-SNAPSHOT</version>
<scope>provided</scope>
</dependency>
Or alternatively, with Gradle:
- Repository:
repositories {
maven {
url 'https://papermc.io/repo/repository/maven-public/'
}
}
- Artifact:
dependencies {
compileOnly 'com.destroystokyo.paper:paper-api:1.16.2-R0.1-SNAPSHOT'
}
How To (Compiling Jar From Source)
To compile Paper, you need JDK 8, maven, and an internet connection.
Clone this repo, run ./paper jar from bash, get files.
How To (Pull Request)
See Contributing
Special Thanks To:
YourKit, makers of the outstanding java profiler, support open source projects of all kinds with their full featured Java and .NET application profilers. We thank them for granting Paper an OSS license so that we can make our software the best it can be.