Go to file
Riley Park 4e958e229f
We're going on an Adventure! (#4842)
Co-authored-by: Jake Potrebic <jake.m.potrebic@gmail.com>
Co-authored-by: zml <zml@stellardrift.ca>
Co-authored-by: Mariell Hoversholm <proximyst@proximyst.com>
2021-02-21 20:45:33 +01:00
.github [CI-SKIP] [Meta] Exempt more labels from being marked as stale (#5142) 2021-02-08 11:26:21 +01:00
Paper-MojangAPI Updated Upstream (Bukkit/CraftBukkit/Spigot) 2021-01-16 02:18:38 +00:00
Spigot-API-Patches We're going on an Adventure! (#4842) 2021-02-21 20:45:33 +01:00
Spigot-Server-Patches We're going on an Adventure! (#4842) 2021-02-21 20:45:33 +01:00
licenses [CI-SKIP] Clarify project licensing 2018-03-06 20:41:03 -05:00
removed Reimplement GS4QueryEvent 2021-01-04 20:17:29 +01:00
scripts Optimize Dynamic#get Missing Keys 2020-12-21 11:03:36 -05:00
work We're going on an Adventure! (#4842) 2021-02-21 20:45:33 +01: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
CONTRIBUTING.md [CI-SKIP] Add `curl` requirement for building paper. (#4768) 2020-11-15 16:42:05 -06:00
LICENSE.md Add missing effects 2021-01-30 21:53:52 +01:00
README.md [CI-SKIP] Fix YourKit links in readme, fixes #5091 2021-01-30 14:19:50 +01:00
UPDATE_NOTES.md Updated Upstream (Bukkit/CraftBukkit/Spigot) (#4728) 2020-11-02 20:22:15 -06:00
paper [CI-SKIP] Add a few missing commands to the ./paper help output 2021-01-07 21:20:35 +01:00
pom.xml Implement Brigadier Mojang API 2020-04-27 01:42:12 -04:00

README.md

Paper GitHub Workflow Status (branch)

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 Paper from our downloads page.

Run the Paperclip jar directly from your server. Just like old times

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.16.5-R0.1-SNAPSHOT</version>
    <scope>provided</scope>
</dependency>

Or alternatively, with Gradle:

  • Repository:
repositories {
    maven {
        url 'https://papermc.io/repo/repository/maven-public/'
    }
}
  • Artifact:
dependencies {
    compileOnly 'com.destroystokyo.paper:paper-api:1.16.5-R0.1-SNAPSHOT'
}

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-Logo

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.