Go to file
Aikar 08c9934f83 update README for PR instructions 2016-03-28 23:59:19 -04:00
.github Update ISSUE_TEMPLATE.md 2016-03-26 14:00:59 +01:00
BuildData@29cbded5ff Submodules 2016-03-03 03:46:48 -06:00
Bukkit@56605a05f6 Update upstream B/CB 2016-03-28 15:21:30 -05:00
CraftBukkit@44216f12ed Update upstream 2016-03-28 23:19:49 -04:00
Paperclip@1d8ff24ec3 Upstream merge Bukkit, update Paperclip 2016-03-21 09:04:19 -05:00
Spigot@2038f4a1ee Update upstream B/CB/Spigot and rebuild 2016-03-27 20:48:50 -05:00
Spigot-API-Patches Remove, not invalidate, Metadata on reload 2016-03-28 22:43:05 -04:00
Spigot-Server-Patches Add a workaround for bugged Minecart drop names 2016-03-28 22:41:27 -05:00
.gitignore Update for upstream changes 2016-03-03 04:07:25 -06:00
.gitmodules Update module urls 2016-03-28 20:38:51 -04:00
.travis.yml Paper 1.9 2016-03-03 03:46:49 -06:00
CONTRIBUTING.md Add issue template 2016-03-25 17:11:17 -04:00
README.md update README for PR instructions 2016-03-28 23:59:19 -04:00
applyPatches.sh ensure upstream is set correctly on apply patches 2016-03-25 00:11:58 -04:00
build.sh Abort properly on error for build script 2016-03-24 20:39:20 -04:00
decompile.sh Paper 1.9 2016-03-03 03:46:49 -06:00
init.sh Abort properly on error for build script 2016-03-24 20:39:20 -04:00
makemcdevsrc.sh Add makemcdevsrc.sh 2016-03-08 22:08:16 -05:00
paperclip.sh Fix chest sound playing at the wrong locaton 2016-03-04 17:49:32 -06:00
pom.xml set default goals on all pom poms </cheer> 2016-03-18 02:13:51 -04:00
rebuildPatches.sh Fix rebuild patches for real this time. 2016-03-21 21:40:18 -04:00
remap.sh Basic OS X compatibility: It works 2016-01-26 01:50:49 -06:00
upstreamMerge.sh Update upstream Spigot and upstreamMerge script 2016-03-21 12:32:05 -05:00

README.md

Paper CI Status

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

IRC Support and Project Discussion

Documentation

Access the paper docs here: paper.readthedocs.org

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 buildserver here: https://ci.destroystokyo.com/job/PaperSpigot/

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

Paper requires Java 8 or above.

How To (Compiling Jar From Source)

To compile Paper, you need JDK 8, maven, and an internet connection.

Clone this repo, run ./build.sh --jar from bash, get files.

Leave off --jar if you only wish to resync your checkout and not create a paperclip jar file just yet.

How To (Pull Request)

Clone this repo, run ./build.sh from bash, get files.

Load Paper-API and Paper-Server into your IDE, make changes.

Commit your changes in each retrospective folder.

If you are editing a previous patch, commit, and then use git rebase -i upstream/upstream and then move your commit line to the commit you are editing and use code "f" or "s"

Once your commit is in place, cd back into Paper folder, and type ./rebuildPatches.sh

You should now see either a new patch or an edited patch in your git status

Now, write a commit message for the patch files. For new patches, you can just repeat the commit message used in the patch commit itself, but if editing, explain what the change to the patch is.

now git checkout -b someBranchName, then git remote add myorigin git@github.com:myname/Paper and git push myorigin someBranchName and then proceed to PR.

Special Thanks To:

YourKit-Logo

YourKit, makers of the outstanding java profiler, support open source projects of all kinds with their full featured Java and .NET application profilers. We thank them for granting Paper an OSS license so that we can make our software the best it can be.