CraftBukkit modifications and Bukkit API additions that fix bugs, add new features, and improve the quality of life
SportBukkit is a fork of CraftBukkit, starting from the submodules in the
The differences between CraftBukkit and SportBukkit are represented by the sequential patches in the
Conceptually, these differences are divided into fixes and features.
Fixes are relatively small and have the potential to change or go away with future upstream changes. Every patch except the final one in each list contains a fix.
Feature changes are improvements and extensions to the Bukkit API, intended to be permanent. These are contained entirely in a single patch at the end of each sequence, called simply "SportBukkit".
For readability purposes, a copy of the final patched SportBukkit source code is stored in the
This code is updated automatically by scripts, and should not be manually edited or compiled.
To build SportBukkit, the following will need to be installed and available from your shell:
- JDK 8 version 121 or later (older versions might work, but some are known not to)
- Ruby version 2.1 or later
Currently, the only known way to build on Windows is with WSL. Other approaches run into problems with wildcard expansion. There are plans to fix this so that SportBukkit can at least be built with any Windows version of Bash, and possibly just the plain Windows shell.
See all available tasks:
The SportBukkit binary will be located in build/CraftBukkit/target
Generate patched SportBukkit source code:
Generated source will be in build/Bukkit and build/CraftBukkit
Compile SportBukkit from source:
Rebuild SportBukkit patches from source:
Remove all intermediate files:
This is roughly the process used to rebase SportBukkit to an updated upstream CraftBukkit.
- Create a branch of this repo called
- Checkout the
build/CraftBukkitand ensure they have clean work trees.
- Delete the
- Reset the submodules
base/CraftBukkitto the latest upstream master.
NMS_MD5to the latest values (running
rake deobfwith the wrong MD5 will show you the right one).
rake decompile, and
rake craftbukkit, in that order. These should all run without any conflicts.
- At this stage, you have the latest CraftBukkit present and are ready to start the actual rebasing.
This is a good time to create an initial commit on the rebase branch, with just the submodule and
rake apply. This will attempt to apply the SportBukkit patches in the
CraftBukkitfolders to the new CraftBukkit. Assuming there have been upstream changes, many of these patches will fail and you will need to resolve the conflicts.
- For each conflict, one of the repos
build/CraftBukkitwill be in a
git amsession, waiting on conflict resolution. Use the standard git merge process to resolve the conflict, and type
git am --continueto continue applying patches.
- Along the way, you can run
rake generateto capture your progress in the patch files.
- When you get to the end of the Bukkit patches, rebuild them and then run
rake applyagain to continue with the CraftBukkit patches.
- The first CraftBukkit patch is strictly for importing NMS files verbatim. To recreate this patch, just copy the latest NMS version of each file
in the patch from
build/CraftBukkit/src/main/java. This patch should always be updated, even if there are no merge conflicts.
- The second CraftBukkit patch is strictly for fixing decompile errors. This patch should only make minimal changes to the files in the first patch to make them compile.