Paper/README.md

42 lines
1.6 KiB
Markdown
Raw Normal View History

Paper [![Build Status](https://destroystokyo.com/ci/job/Paper/badge/icon)](https://destroystokyo.com/ci/job/Paper/)
===========
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
2016-09-04 06:26:05 +00:00
[IRC Support and Project Discussion](http://irc.spi.gt/iris/?channels=paper)
2013-06-16 19:45:21 +00:00
[Discord](https://discord.gg/jETyjUw)
2014-08-19 18:56:57 +00:00
2016-03-29 03:59:04 +00:00
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/)
2014-11-29 21:15:05 +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.
Download a copy of paperclip.jar from [our build server, here](https://destroystokyo.com/ci/job/PaperSpigot/).
2014-08-19 18:56:57 +00:00
Run the Paperclip jar directly from your server. Just like old times
2013-06-16 19:45:21 +00:00
2016-03-29 03:59:04 +00:00
Paper requires [**Java 8**](http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html) or above.
2016-01-26 18:53:16 +00:00
2016-03-29 03:59:04 +00:00
How To (Compiling Jar From Source)
2016-01-26 18:53:16 +00:00
------
To compile Paper, you need JDK 8, maven, and an internet connection.
2016-01-26 18:53:16 +00:00
2016-04-03 09:51:14 +00:00
Clone this repo, run `./paper jar` from *bash*, get files.
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:
-------------
![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.