mirror of
https://github.com/PaperMC/Paper.git
synced 2024-09-12 06:58:11 +02:00
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.
42 lines
1.6 KiB
Markdown
42 lines
1.6 KiB
Markdown
Paper [![Build Status](https://destroystokyo.com/ci/job/Paper/badge/icon)](https://destroystokyo.com/ci/job/Paper/)
|
|
===========
|
|
|
|
High performance Spigot fork that aims to fix gameplay and mechanics inconsistencies.
|
|
|
|
[IRC Support and Project Discussion](http://irc.spi.gt/iris/?channels=paper)
|
|
|
|
[Discord](https://discord.gg/jETyjUw)
|
|
|
|
|
|
Documentation
|
|
------
|
|
Access the Paper docs here: [paper.readthedocs.io](https://paper.readthedocs.io/)
|
|
Access the Paper API javadocs here: [destroystokyo.com/javadocs](https://destroystokyo.com/javadocs/)
|
|
|
|
How To (Server Admins)
|
|
------
|
|
Paperclip is a jar file that you can download and run just like a normal jar file.
|
|
|
|
Download a copy of paperclip.jar from [our build server, here](https://destroystokyo.com/ci/job/PaperSpigot/).
|
|
|
|
Run the Paperclip jar directly from your server. Just like old times
|
|
|
|
Paper requires [**Java 8**](http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html) or above.
|
|
|
|
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.
|