Go to file
Pedro Arenas d8ad276b7d
[ci skip] More badges and things to README.md (#5338)
* Update README.md

* Update README.md

Remove license badge and fix letters

* Update README.md

* Update README.md

Many many time in this PR... now pass to java 16

* Update README.md

Add discord badge

* Update README.md

Fix format

* Update README.md

Change url to patches (because Spigot-API-Patches change)

* Update README.md

* Update README.md

Apply suggest url to patches

Co-authored-by: Olivia <chew@chew.pw>

* Update README.md

Update paper version from 1.17 to 1.17.1

* Update README.md

A better badge for discord (IRC not have a custom badge or any...)

* Update README.md

Update style.

Co-authored-by: Olivia <chew@chew.pw>
2021-07-08 16:41:46 +02:00
.github [ci skip] Performance boost! (#5942) 2021-06-21 15:18:07 -07:00
Paper-MojangAPI remove remaining POMs 2021-06-17 10:11:00 -07:00
build-data Fix MobEffectArgument#getEffect reobf 2021-07-07 15:54:43 +02:00
gradle/wrapper Gradle & Paperclip updates 2021-06-14 23:17:16 -05:00
licenses [CI-SKIP] Clarify project licensing 2018-03-06 20:41:03 -05:00
patches Fix cancelling EntityPickupItemEvent for villagers (#6091) 2021-07-07 11:07:38 -07:00
scripts Clean cache on upstream update 2021-06-15 01:38:41 -07:00
work Update to Minecraft 1.17.1 (#6097) 2021-07-07 06:52:40 +00: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 Update paperweight & build config for Spigot changes 2021-06-11 06:34:57 -05:00
.gitmodules Remove Paperclip submodule 2021-06-15 01:44:13 -05:00
CONTRIBUTING.md [CI-SKIP] Add PR rebasing steps (#5634) 2021-05-16 16:29:19 +00:00
LICENSE.md Drop no longer needed patch (#6115) 2021-07-07 19:18:05 +02:00
README.md [ci skip] More badges and things to README.md (#5338) 2021-07-08 16:41:46 +02:00
build.gradle.kts Update to Minecraft 1.17.1 (#6097) 2021-07-07 06:52:40 +00:00
gradle.properties Update to Minecraft 1.17.1 (#6097) 2021-07-07 06:52:40 +00:00
gradlew Did anyone say gradle? and paperweight? potentially even mojmap?! 2021-06-11 09:45:34 +02:00
gradlew.bat gradlew.bat crlf fix (#5810) 2021-06-12 22:34:05 +01:00
settings.gradle.kts revert accidental changes 2021-06-15 00:28:40 -07:00

README.md

Paper GitHub Workflow Status (branch) Read the Docs (version) version Sonatype Nexus (Query Options) Discord

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 'https://papermc.io/repo/repository/maven-public/'
    }
}
  • Artifact:
dependencies {
    compileOnly 'io.papermc.paper:paper-api:1.17.1-R0.1-SNAPSHOT'
}

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

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.