PaperMC/README.md

Paper [![Build Status](https://papermc.io/ci/job/Paper-1.14/badge/icon)](https://papermc.io/ci/job/Paper-1.14/)
===========

High performance Spigot fork that aims to fix gameplay and mechanics inconsistencies.


**Support and Project Discussion:**
 - [IRC](http://irc.spi.gt/iris/?channels=paper) or [Discord](https://discord.gg/papermc)


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](https://papermc.io/downloads).

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

  * 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/)
 * Maven Repo (for paper-api):
```xml
<repository>
    <id>papermc</id>
    <url>https://papermc.io/repo/repository/maven-public/</url>
</repository>
```
 * Artifact Information:
```xml
<dependency>
    <groupId>com.destroystokyo.paper</groupId>
    <artifactId>paper-api</artifactId>
    <version>1.15.2-R0.1-SNAPSHOT</version>
    <scope>provided</scope>
 </dependency>
 ```

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](CONTRIBUTING.md)

Special Thanks To:
-------------

![YourKit-Logo](https://www.yourkit.com/images/yklogo.png)

[YourKit](http://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/index.jsp) and [.NET](https://www.yourkit.com/.net/profiler/index.jsp) application profilers. We thank them for granting Paper an OSS license so that we can make our software the best it can be.
[CI-SKIP] Update README.md 2019-06-08 23:06:07 +02:00			`Paper [![Build Status](https://papermc.io/ci/job/Paper-1.14/badge/icon)](https://papermc.io/ci/job/Paper-1.14/)`
Initial commit - hello future of Spigot! 2013-01-15 02:18:40 +01:00			`===========`

Update readme with travis and info 2014-07-04 22:34:50 +02:00			`High performance Spigot fork that aims to fix gameplay and mechanics inconsistencies.`
Add a few links to the README.md 2014-08-19 20:56:57 +02:00
ReadMe Edit 2013-06-16 21:45:21 +02:00
[CI-SKIP] Use papermc.io domain and add info for plugin devs 2018-09-12 01:50:07 +02:00			`Support and Project Discussion:`
[CI-SKIP] Update README.md 2019-06-08 23:06:07 +02:00			`- [IRC](http://irc.spi.gt/iris/?channels=paper) or [Discord](https://discord.gg/papermc)`
Update URLs Redirects are in place (or will be shortly). This is mostly housekeeping. Maven repo URLs already redirect however we can't deploy through them. Jenkins URLs do not currently redirect but will within 24 hours. Also adds a Discord link to the README, because apparently that's what people want. Documentation will be updated and announcements made once all redirects are in place, until then, consider this advanced notice. 2018-05-19 08:29:05 +02:00
Add a few links to the README.md 2014-08-19 20:56:57 +02:00
Update README.md, thanks YourKit 2016-01-26 19:53:16 +01:00			`How To (Server Admins)`
Update readme 2014-11-29 22:12:04 +01:00			`------`
update README for PR instructions 2016-03-29 05:59:04 +02:00			`Paperclip is a jar file that you can download and run just like a normal jar file.`

[CI-SKIP] Update download link to website 2018-10-30 00:55:36 +01:00			`Download Paper from our [downloads page](https://papermc.io/downloads).`
Add a few links to the README.md 2014-08-19 20:56:57 +02:00
Update README.md Remove all reamining instances of `PaperSpigot` and replace them with `Paper` 2016-03-21 01:32:00 +01:00			`Run the Paperclip jar directly from your server. Just like old times`
ReadMe Edit 2013-06-16 21:45:21 +02:00
[CI-SKIP] Use papermc.io domain and add info for plugin devs 2018-09-12 01:50:07 +02: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/)`
[CI-SKIP] Add more detailed information for plugin devs 2018-09-23 19:52:37 +02: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>`
			`<groupId>com.destroystokyo.paper</groupId>`
			`<artifactId>paper-api</artifactId>`
1.15.2 update (#2887) Functional GUI fix added by billygalbreath 2020-01-22 03:02:07 +01:00			`<version>1.15.2-R0.1-SNAPSHOT</version>`
[CI-SKIP] Add more detailed information for plugin devs 2018-09-23 19:52:37 +02:00			`<scope>provided</scope>`
			`</dependency>`
			```
Update README.md, thanks YourKit 2016-01-26 19:53:16 +01:00
update README for PR instructions 2016-03-29 05:59:04 +02:00			`How To (Compiling Jar From Source)`
Update README.md, thanks YourKit 2016-01-26 19:53:16 +01:00			`------`
Update README.md Remove all reamining instances of `PaperSpigot` and replace them with `Paper` 2016-03-21 01:32:00 +01:00			`To compile Paper, you need JDK 8, maven, and an internet connection.`
Update README.md, thanks YourKit 2016-01-26 19:53:16 +01:00
lazy-update docs 2016-04-03 11:51:14 +02:00			Clone this repo, run `./paper jar` from bash, get files.
Update README.md, thanks YourKit 2016-01-26 19:53:16 +01:00
update README for PR instructions 2016-03-29 05:59:04 +02:00			`How To (Pull Request)`
			`------`
Link to contributing for PR section 2016-03-29 06:07:27 +02:00			`See [Contributing](CONTRIBUTING.md)`
update README for PR instructions 2016-03-29 05:59:04 +02:00
Update README.md, thanks YourKit 2016-01-26 19:53:16 +01:00			`Special Thanks To:`
			`-------------`

			`![YourKit-Logo](https://www.yourkit.com/images/yklogo.png)`

Update README.md Remove all reamining instances of `PaperSpigot` and replace them with `Paper` 2016-03-21 01:32:00 +01:00			`[YourKit](http://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/index.jsp) and [.NET](https://www.yourkit.com/.net/profiler/index.jsp) application profilers. We thank them for granting Paper an OSS license so that we can make our software the best it can be.`