2020-12-31 20:56:55 +00:00
Paper 
2013-01-15 01:18:40 +00:00
===========
2014-07-04 20:34:50 +00:00
High performance Spigot fork that aims to fix gameplay and mechanics inconsistencies.
2014-08-19 18:56:57 +00:00
2013-06-16 19:45:21 +00:00
2018-09-11 23:50:07 +00:00
**Support and Project Discussion:**
2020-11-10 08:15:03 +00:00
- [IRC ](https://webchat.esper.net/?channels=paper ) or [Discord ](https://discord.gg/papermc )
2021-01-16 21:02:34 +00:00
2014-08-19 18:56:57 +00:00
2016-01-26 18:53:16 +00:00
How To (Server Admins)
2014-11-29 21:12:04 +00:00
------
2016-03-29 03:59:04 +00:00
Paperclip is a jar file that you can download and run just like a normal jar file.
2018-10-29 23:55:36 +00:00
Download Paper from our [downloads page ](https://papermc.io/downloads ).
2014-08-19 18:56:57 +00:00
2016-03-21 00:32:00 +00:00
Run the Paperclip jar directly from your server. Just like old times
2013-06-16 19:45:21 +00:00
2018-09-11 23:50:07 +00: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)
------
* See our API patches [here ](Spigot-API-Patches )
* 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-23 17:52:37 +00: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-19 19:03:18 +00:00
< groupId > io.papermc.paper< / groupId >
2018-09-23 17:52:37 +00:00
< artifactId > paper-api< / artifactId >
2021-06-19 19:03:18 +00:00
< version > 1.17-R0.1-SNAPSHOT< / version >
2018-09-23 17:52:37 +00:00
< scope > provided< / scope >
2020-07-02 21:44:14 +00:00
< / dependency >
2018-09-23 17:52:37 +00:00
```
2016-01-26 18:53:16 +00:00
2020-06-29 20:14:22 +00:00
**Or alternatively, with Gradle:**
* Repository:
```groovy
repositories {
maven {
url 'https://papermc.io/repo/repository/maven-public/'
}
}
```
* Artifact:
```groovy
dependencies {
2021-06-19 19:03:18 +00:00
compileOnly 'io.papermc.paper:paper-api:1.17-R0.1-SNAPSHOT'
2020-06-29 20:14:22 +00:00
}
```
2016-03-29 03:59:04 +00:00
How To (Compiling Jar From Source)
2016-01-26 18:53:16 +00:00
------
2021-06-19 19:03:18 +00:00
To compile Paper, you need JDK 16 and an internet connection.
2016-01-26 18:53:16 +00:00
2021-06-19 19:03:18 +00: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-26 18:53:16 +00:00
2016-03-29 03:59:04 +00:00
How To (Pull Request)
------
2016-03-29 04:07:27 +00:00
See [Contributing ](CONTRIBUTING.md )
2016-03-29 03:59:04 +00:00
2016-01-26 18:53:16 +00:00
Special Thanks To:
-------------
2021-01-20 15:23:30 +00: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.
