Go to file

Aikar ab2e8a853c Add note to use Personal Forks and not Organization forks for PR's Paper will routinely modify your PR for you to rebase it on latest or take care of any minor nitpicks that we can just solve for you instead of making you go back for a trivial item. However, if you use an Organization for the PR, this prevents Paper from doing this, and will require us to manually merge it and close the PR instead of it being marked as the purple merged. We much prefer to have merged PR's show as merged, so please do not use organizations repo's for PR as GitHub sadly does not support maintainers pushing to them. See [https://github.com/isaacs/github/issues/1681](https://github.com/isaacs/github/issues/1681)		2020-06-20 15:51:03 -04:00
.github/ISSUE_TEMPLATE	[CI-SKIP] Update Issue template	2018-09-26 17:22:20 -04:00
Paper-MojangAPI	Rename to AsyncPlayerSendSuggestionsEvent to be consistent in naming	2020-05-02 15:29:03 -04:00
Spigot-API-Patches	Add Inventory getHolder methods without creating new block snapshots (#3535 )	2020-06-20 15:34:56 -04:00
Spigot-Server-Patches	Add history file for terminal	2020-06-20 15:46:25 -04:00
licenses	[CI-SKIP] Clarify project licensing	2018-03-06 20:41:03 -05: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
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	Add note to use Personal Forks and not Organization forks for PR's	2020-06-20 15:51:03 -04:00
LICENSE.md	Add API MinecraftServer#isStopping (#3129 )	2020-04-11 01:51:35 -04:00
README.md	Update to HTTPS in README (#3460 )	2020-06-09 04:12:43 -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

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.