mirror of https://github.com/PaperMC/Paper.git synced 2024-12-30 21:07:36 +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 8b3952062a [Auto] Updated Upstream (Bukkit) Upstream has released updates that appears to apply and compile correctly. This update has not been tested by PaperMC and as with ANY update, please do your own testing Bukkit Changes: 66b9b8fd Clarify Colorable docs further		2018-10-05 21:01:32 -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
removed	[CI-SKIP] Move removed patches back down a level	2018-09-01 15:39:16 -04:00
scripts	[CI-SKIP] Update test server rebuild logic	2018-10-02 21:49:42 -04:00
Spigot-API-Patches	[CI-SKIP] Remove Trove and update to fastutul 8 on -api	2018-10-03 21:32:11 -04:00
Spigot-Server-Patches	Hook into CB's plugin rewriting system	2018-10-05 19:44:46 -04:00
work	[Auto] Updated Upstream (Bukkit)	2018-10-05 21:01:32 -04:00
.editorconfig	[CI-SKIP] add .editorconfig for base code style settings	2018-08-07 01:14:22 -04:00
.gitignore	Switch to using ForgeFlower for Paper Only mc-dev imports	2018-08-31 23:47:57 -04:00
.gitmodules	Cleanup and restructure the project	2016-04-01 23:15:41 -05:00
.travis.yml	Move mc decompile source to its own folder	2017-08-12 18:56:59 -05:00
CONTRIBUTING.md	[CI-SKIP] Add note on 1.12.2 status to CONTRIBUTING.md	2018-09-11 18:11:28 -04:00
LICENSE.md	Fix view distance API (#1419 )	2018-09-09 14:38:27 -04:00
paper	Updated Upstream (Bukkit/CraftBukkit)	2018-08-31 23:53:54 -04:00
pom.xml	Fix up maven stuff hopefully	2018-09-22 12:58:09 -04:00
README.md	[CI-SKIP] Add more detailed information for plugin devs	2018-09-23 13:52:37 -04: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 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.