Go to file
Jason Penilla 7230cbbd55 lowercase root project name as well 2021-11-30 19:26:33 +01:00
.github java 17 2021-11-30 19:26:33 +01:00
Paper-MojangAPI Upgrade paperweight with bundler jar updates 2021-11-30 19:26:33 +01:00
build-data More more more more more more more more more more more more more work 2021-11-30 19:26:33 +01:00
gradle/wrapper Update paperweight to 1.2.0 (#6901) 2021-11-16 21:00:14 -08:00
licenses [CI-SKIP] Clarify project licensing 2018-03-06 20:41:03 -05:00
patches Fix stacktrace deobf when running as a bundler jar 2021-11-30 19:26:33 +01:00
scripts Clean cache on upstream update 2021-06-15 01:38:41 -07:00
test-plugin Prepare for updating server patches 2021-11-30 19:26:33 +01:00
work Updated Upstream (Bukkit/CraftBukkit/Spigot) 2021-11-30 19:26:33 +01:00
.editorconfig Update editorconfig 2021-06-14 21:02:20 -07:00
.gitattributes Fix patch, fix .gitattributes file name 2021-06-12 14:09:11 +02:00
.gitignore [ci skip] Add a test plugin (#6133) 2021-07-09 03:04:33 -07:00
.gitmodules Remove Paperclip submodule 2021-06-15 01:44:13 -05:00
CONTRIBUTING.md docs: drop table of contents; it's built into GH 2021-09-02 08:14:56 +02:00
LICENSE.md Update email & name (DenWav) 2021-07-19 21:07:53 -05:00
README.md Add donation badges and support us section to readme 2021-10-24 19:22:08 +02:00
build.gradle.kts Upgrade paperweight with bundler jar updates 2021-11-30 19:26:33 +01:00
gradle.properties Updated Upstream (Bukkit/CraftBukkit/Spigot) 2021-11-30 19:26:33 +01:00
gradlew [ci skip] Bump paperweight to 1.1.11, update Gradle wrapper script (#6421) 2021-08-18 13:34:52 -05:00
gradlew.bat gradlew.bat crlf fix (#5810) 2021-06-12 22:34:05 +01:00
settings.gradle.kts lowercase root project name as well 2021-11-30 19:26:33 +01:00
todo.txt Rename optimize isOutsideRange patch 2021-11-30 19:26:33 +01:00

README.md

Paper Paper Build Status Discord GitHub Sponsors Open Collective

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>io.papermc.paper</groupId>
    <artifactId>paper-api</artifactId>
    <version>1.17.1-R0.1-SNAPSHOT</version>
    <scope>provided</scope>
</dependency>

Or alternatively, with Gradle:

  • Repository:
repositories {
    maven {
        url = uri("https://papermc.io/repo/repository/maven-public/")
    }
}

dependencies {
    compileOnly("io.papermc.paper:paper-api:1.17.1-R0.1-SNAPSHOT")
}

java {
    toolchain.languageVersion.set(JavaLanguageVersion.of(16))
}

How To (Compiling Jar From Source)

To compile Paper, you need JDK 16 and an internet connection.

Clone this repo, run ./gradlew applyPatches, then ./gradlew reobfJar from your terminal. You can find the compiled jar in the Paper-Server/build/libs directory.

To get a full list of tasks, run ./gradlew tasks.

How To (Pull Request)

See Contributing

Support Us

First of all, thank you for considering helping out, we really appreciate that!

PaperMC has various recurring expenses, mostly related to infrastructure. Paper uses Open Collective via the Open Source Collective fiscal host to manage expenses. Open Collective allows us to be extremely transparent, so you can always see how your donations are used. You can read more about finanically supporting PaperMC on our website.

You can find our collective here, or you can donate via GitHub Sponsors here, which will also go towards the collective.

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.

JetBrains, creators of the IntelliJ IDEA, supports Paper with one of their Open Source Licenses. IntelliJ IDEA is the recommended IDE for working with Paper, and most of the Paper team uses it.

All our sponsors!
Sponsor Image