Go to file

egg82 555ca59af7 Add root/admin user detection (#2432 ) This patch detects whether or not the server is currently executing as a privileged user and spits out a warning. The warning serves as a sort-of PSA for newer server admins who don't understand the risks of running as root. We've seen plenty of bad/malicious plugins hit markets, and there's been a few close-calls with exploits in the past. Hopefully this helps mitigate some potential damage to servers, even if it is just a warning.		2020-02-18 22:10:41 -06:00
.github/ISSUE_TEMPLATE	[CI-SKIP] Update Issue template	2018-09-26 17:22:20 -04:00
Spigot-API-Patches	Stop stripping private use block Unicode from signs	2020-02-10 22:35:46 -06:00
Spigot-Server-Patches	Add root/admin user detection (#2432 )	2020-02-18 22:10:41 -06:00
licenses	[CI-SKIP] Clarify project licensing	2018-03-06 20:41:03 -05:00
removed	Port activation range improvement patch (#2763 )	2020-01-20 15:54:57 +00:00
scripts	Performance patches prerequisite (#2802 )	2020-01-27 18:16:53 -06:00
work	Update upstream CB	2020-02-18 18:58:19 -06:00
.editorconfig	[CI-SKIP] add .editorconfig for base code style settings	2018-08-07 01:14:22 -04:00
.gitignore	Hey vscode, get your files outta my repo	2019-06-08 15:38:10 -05: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	[CI-SKIP] Passage outdated (#2776 )	2020-01-09 19:43:46 -06:00
LICENSE.md	Change the reserved channel check to be sensible (#1610 )	2018-11-30 19:08:31 -05:00
README.md	[CI-SKIP] Update build badge in README to use proper job	2020-02-08 17:58:39 -06:00
paper	Try and make zsh complain less	2018-10-24 12:36:37 -04:00
pom.xml	Fix up maven stuff hopefully	2018-09-22 12:58:09 -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.