mirror of https://github.com/PaperMC/Paper.git synced 2024-11-22 18:45:54 +01:00

High performance Spigot fork that aims to fix gameplay and mechanics inconsistencies

bukkit craftbukkit hacktoberfest java minecraft minecraft-api minecraft-performance minecraft-server paper paper-api papermc spigot-fork tacos

Go to file

Aikar 531c4b3fd1 Add PluginTickets to API Chunk Methods Like previous versions, plugins loading chunks kept them loaded until they garbage collected to avoid constant spamming of chunk loads This adds tickets to a few more places so that they can be unloaded. Additionally, this drops their ticket level to BORDER so they wont be ticking so they will just sit inactive instead. Using .loadChunk to keep a chunk ticking was a horrible idea for upstream when we have TWO methods that are able to do that already in the API. Not adding it to .getType() though to keep behavior consistent with vanilla.		2020-06-09 03:43:11 -04:00
.github/ISSUE_TEMPLATE	[CI-SKIP] Update Issue template	2018-09-26 17:22:20 -04:00
licenses	[CI-SKIP] Clarify project licensing	2018-03-06 20:41:03 -05:00
Paper-MojangAPI	Rename to AsyncPlayerSendSuggestionsEvent to be consistent in naming	2020-05-02 15:29:03 -04:00
removed	Drop remove leaked chunk patch - causing many issues	2020-05-29 03:32:13 -04:00
scripts	Preload important classes such as Logger and JLine	2020-05-24 13:19:08 -04:00
Spigot-API-Patches	Change name and id to get from profile in AsyncPlayerPreLoginEvent (#3511 )	2020-06-07 14:36:13 -04:00
Spigot-Server-Patches	Add PluginTickets to API Chunk Methods	2020-06-09 03:43:11 -04:00
work	Updated Upstream (Bukkit/CraftBukkit)	2020-06-02 01:29:18 -04:00
.editorconfig	[CI-SKIP] add .editorconfig for base code style settings	2018-08-07 01:14:22 -04:00
.gitignore	Fix ./paper edit continue for Windows	2020-05-19 23:14:34 -04:00
.gitmodules	Cleanup and restructure the project	2016-04-01 23:15:41 -05:00
.travis.yml	[CI-SKIP] Have travis ensure openjdk11 builds run	2018-10-24 16:26:47 -04:00
CONTRIBUTING.md	Fix path in CONTRIBUTING.md (#3406 )	2020-05-19 23:08:37 -04:00
LICENSE.md	Add API MinecraftServer#isStopping (#3129 )	2020-04-11 01:51:35 -04:00
paper	Optimize sending packets to nearby locations (sounds/effects)	2020-05-23 17:17:14 -04:00
pom.xml	Implement Brigadier Mojang API	2020-04-27 01:42:12 -04:00
README.md	[CI-SKIP] Update build badge in README to use proper job	2020-02-08 17:58:39 -06:00

README.md

Paper

High performance Spigot fork that aims to fix gameplay and mechanics inconsistencies.

Support and Project Discussion:

IRC or Discord

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.15.2-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.