mirror of
https://github.com/PaperMC/Paper.git
synced 2024-09-06 20:08:13 +02:00
High performance Spigot fork that aims to fix gameplay and mechanics inconsistencies
bukkitcraftbukkithacktoberfestjavaminecraftminecraft-apiminecraft-performanceminecraft-serverpaperpaper-apipapermcspigot-forktacos
Shared Hosts have been concerned over the increased CPU usage that Async Chunks has introduced. We understand that shared hosts can't allow 1 client to abuse the systme resources depriving other servers of cpu time, so we've added some configs to allow hosts to force some settings. Hosts, you may set the following SYSTEM ENVIRONMENT VARIABLES (NOT JVM FLAGS) to change some behavior: PAPER_ASYNC_CHUNKS_SHARED_HOST_GEN=1 - Enable Single Threaded World Generation (capping CPU Usage PAPER_ASYNC_CHUNKS_SHARED_HOST_GEN=2 - Disable Async Chunk Generation - Please do not do this!!! - Minecraft is moving towards asynchronousm per-world chunk generation itself. You need to prepare - for this, so please do not disable async chunk generation. PAPER_ASYNC_CHUNKS_SHARED_HOST_LOAD=# - Where # is Maximum number of threads to use on Chunk Loading - This is a max, so your end user can reduce it more too. I suggest no lower than 2. Minimum is 1. - These are usually much faster request, so outside of loading entire worlds, They usually do not - get as much load. Paperby default uses CPU Core count * 1.5, so this may default to a higher value - on shared host and you should override it with this value to say 2-4. These settings will override your clients paper.yml options. Set as a system wide environment variable to ensure all Paper clients respect your resource usage desires. Resolves #1520 |
||
---|---|---|
.github/ISSUE_TEMPLATE | ||
licenses | ||
removed | ||
scripts | ||
Spigot-API-Patches | ||
Spigot-Server-Patches | ||
work | ||
.editorconfig | ||
.gitignore | ||
.gitmodules | ||
.travis.yml | ||
CONTRIBUTING.md | ||
LICENSE.md | ||
paper | ||
pom.xml | ||
README.md |
Paper ![Build Status](https://papermc.io/ci/job/Paper/badge/icon)
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 a copy of paperclip.jar from our build server, here.
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.13.1-R0.1-SNAPSHOT</version>
<scope>provided</scope>
</dependency>
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.