2021-10-04 15:32:57 +08:00
Paper [](https://github.com/PaperMC/Paper/actions)
2021-07-08 22:41:46 +08:00
[](https://discord.gg/papermc)
2013-01-15 09:18:40 +08:00
===========
2014-07-05 04:34:50 +08:00
High performance Spigot fork that aims to fix gameplay and mechanics inconsistencies.
2014-08-20 02:56:57 +08:00
2013-06-17 03:45:21 +08:00
2018-09-12 07:50:07 +08:00
**Support and Project Discussion:**
2020-11-10 16:15:03 +08:00
- [IRC ](https://webchat.esper.net/?channels=paper ) or [Discord ](https://discord.gg/papermc )
2021-01-17 05:02:34 +08:00
2014-08-20 02:56:57 +08:00
2016-01-27 02:53:16 +08:00
How To (Server Admins)
2014-11-30 05:12:04 +08:00
------
2016-03-29 11:59:04 +08:00
Paperclip is a jar file that you can download and run just like a normal jar file.
2018-10-30 07:55:36 +08:00
Download Paper from our [downloads page ](https://papermc.io/downloads ).
2014-08-20 02:56:57 +08:00
2016-03-21 08:32:00 +08:00
Run the Paperclip jar directly from your server. Just like old times
2013-06-17 03:45:21 +08:00
2018-09-12 07:50:07 +08:00
* Documentation on using Paper: [paper.readthedocs.io ](https://paper.readthedocs.io/ )
* For a sneak peak on upcoming features, [see here ](https://github.com/PaperMC/Paper/projects )
How To (Plugin Developers)
------
2021-07-08 22:41:46 +08:00
* See our API patches [here ](patches/api )
2018-09-12 07:50:07 +08:00
* See upcoming, pending, and recently added API [here ](https://github.com/PaperMC/Paper/projects/6 )
* Paper API javadocs here: [papermc.io/javadocs ](https://papermc.io/javadocs/ )
2018-09-24 01:52:37 +08:00
* Maven Repo (for paper-api):
```xml
< repository >
< id > papermc< / id >
< url > https://papermc.io/repo/repository/maven-public/< / url >
< / repository >
```
* Artifact Information:
```xml
< dependency >
2021-06-20 03:03:18 +08:00
< groupId > io.papermc.paper< / groupId >
2018-09-24 01:52:37 +08:00
< artifactId > paper-api< / artifactId >
2021-07-08 22:41:46 +08:00
< version > 1.17.1-R0.1-SNAPSHOT< / version >
2018-09-24 01:52:37 +08:00
< scope > provided< / scope >
2020-07-03 05:44:14 +08:00
< / dependency >
2018-09-24 01:52:37 +08:00
```
2016-01-27 02:53:16 +08:00
2020-06-30 04:14:22 +08:00
**Or alternatively, with Gradle:**
* Repository:
2021-10-21 17:04:17 +08:00
```kotlin
2020-06-30 04:14:22 +08:00
repositories {
maven {
2021-10-21 17:04:17 +08:00
url = uri("https://papermc.io/repo/repository/maven-public/")
2020-06-30 04:14:22 +08:00
}
}
2021-10-21 17:04:17 +08:00
2020-06-30 04:14:22 +08:00
dependencies {
2021-10-21 17:04:17 +08:00
compileOnly("io.papermc.paper:paper-api:1.17.1-R0.1-SNAPSHOT")
}
java {
toolchain.languageVersion.set(JavaLanguageVersion.of(16))
2020-06-30 04:14:22 +08:00
}
```
2016-03-29 11:59:04 +08:00
How To (Compiling Jar From Source)
2016-01-27 02:53:16 +08:00
------
2021-06-20 03:03:18 +08:00
To compile Paper, you need JDK 16 and an internet connection.
2016-01-27 02:53:16 +08:00
2021-06-20 03:03:18 +08:00
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` .
2016-01-27 02:53:16 +08:00
2016-03-29 11:59:04 +08:00
How To (Pull Request)
------
2016-03-29 12:07:27 +08:00
See [Contributing ](CONTRIBUTING.md )
2016-03-29 11:59:04 +08:00
2016-01-27 02:53:16 +08:00
Special Thanks To:
-------------
2021-06-20 20:29:09 +08:00
[](https://www.yourkit.com/)
2016-01-27 02:53:16 +08:00
2021-01-20 23:23:30 +08:00
[YourKit ](https://www.yourkit.com/ ), makers of the outstanding java profiler, support open source projects of all kinds with their full featured [Java ](https://www.yourkit.com/java/profiler ) and [.NET ](https://www.yourkit.com/.net/profiler ) application profilers. We thank them for granting Paper an OSS license so that we can make our software the best it can be.
2021-06-20 20:29:09 +08:00
[<img src="https://user-images.githubusercontent.com/21148213/121807008-8ffc6700-cc52-11eb-96a7-2f6f260f8fda.png" alt="" width="150"> ](https://www.jetbrains.com )
[JetBrains ](https://www.jetbrains.com/ ), creators of the IntelliJ IDEA, supports Paper with one of their [Open Source Licenses ](https://www.jetbrains.com/opensource/ ). IntelliJ IDEA is the recommended IDE for working with Paper, and most of the Paper team uses it.
