Paper/README.md

67 lines
1.6 KiB
Markdown
Raw Normal View History

2014-08-10 01:15:45 +02:00
PaperSpigot [![CI Status](http://ci.destroystokyo.com/buildStatus/icon?job=PaperSpigot)](http://ci.destroystokyo.com/job/PaperSpigot/) [![Travis Status](https://travis-ci.org/PaperSpigot/PaperSpigot.svg?branch=master)](https://travis-ci.org/PaperSpigot/PaperSpigot)
===========
2014-07-04 22:34:50 +02:00
High performance Spigot fork that aims to fix gameplay and mechanics inconsistencies.
2014-08-19 20:56:57 +02:00
2014-07-04 22:34:50 +02:00
[IRC Support and Project Discussion](http://irc.spi.gt/iris/?channels=PaperSpigot)
2013-06-16 21:45:21 +02:00
2014-08-19 20:56:57 +02:00
2014-11-29 22:15:05 +01:00
2014-11-29 22:12:04 +01:00
How To
------
Download a copy of PaperTools.jar from our buildserver here:
2014-11-30 23:19:13 +01:00
https://ci.destroystokyo.com/job/PaperSpigot-BuildTools/
2014-08-19 20:56:57 +02:00
2014-11-29 22:12:04 +01:00
Place PaperTools.jar into an empty directory and run it with `java -jar PaperTools.jar` from Git-Bash/Bash
2013-06-16 21:45:21 +02:00
2014-11-29 22:12:04 +01:00
It requires you have git installed on your local system as well as JDK 7 or above.
2014-11-29 22:15:05 +01:00
2014-11-29 22:12:04 +01:00
How To (Advanced & Legacy Users)
---------------------------------
2013-06-16 21:45:21 +02:00
2014-11-29 22:12:04 +01:00
After running the PaperTools jar, you can compile at any time. A brief overview is provided below.
For more novice users, we recommend you avoid these steps and stick to the PaperTools.jar build tool.
2013-06-16 21:45:21 +02:00
Apply Patches : `./applyPatches.sh`
### Create patch for server ###
2014-07-21 22:57:32 +02:00
`cd PaperSpigot-Server`
2013-06-16 21:48:08 +02:00
2013-06-16 21:45:21 +02:00
Add your file for commit : `git add <file>`
2013-06-16 21:48:08 +02:00
2013-06-16 21:45:21 +02:00
Commit : `git commit -m <msg>`
2013-06-16 21:48:08 +02:00
2013-06-16 21:45:21 +02:00
`cd ..`
2013-06-16 21:48:08 +02:00
2013-06-16 21:45:21 +02:00
Create Patch `./rebuildPatches.sh`
### Create patch for API ###
2014-07-21 22:57:32 +02:00
`cd Paperspigot-API`
2013-06-16 21:48:08 +02:00
2013-06-16 21:45:21 +02:00
Add your file for commit : `git add <file>`
2013-06-16 21:48:08 +02:00
2013-06-16 21:45:21 +02:00
Commit : `git commit -m <msg>`
2013-06-16 21:48:08 +02:00
2013-06-16 21:45:21 +02:00
`cd ..`
2013-06-16 21:48:08 +02:00
2013-06-16 21:45:21 +02:00
Create Patch `./rebuildPatches.sh`
2013-06-16 21:48:08 +02:00
2013-06-16 21:45:21 +02:00
Compilation
-----------
We use maven to handle our dependencies.
* Install [Maven 3](http://maven.apache.org/download.html)
2013-07-03 07:06:27 +02:00
* Clone this repo and: `mvn clean install`