Future removal of CB package relocation + moving away from obfuscation at runtime
If you are not a developer but a server owner, this might still be important for you. Check the bottom section on what action you might have to take.As already announced before, at some point in the foreseeable future, we will remove the CraftBukkit package relocation (e.g.
v1_20_R3). This may be as soon as 1.20.5, as we expect almost every plugin using internals to break due to major changes in vanilla anyways.If any of your plugins use internals, please test whether they are able to run on such a server by using a test release:
https://github.com/PaperMC/testing/releases/tag/no-relocation
Note: This also includes testing of automated remapping of plugins to make them run on Mojang mapped servers, even if a plugin is compiled against the obfuscated class and method names (if you don't use any vanilla internals, this doesn't affect you). So even if you have already fixed CB package parsing, please check whether your plugins are able to run on this jar if they are using internals (or "nms").
Once these changes are present in stable Paper builds, you can expect a much better experience when using the often dreaded internals by using our userdev Gradle plugin. Most notably, small Minecraft updates will no longer unconditionally break your plugins.
How to make sure your plugin does not break
If you reflect on CB classesEasy, just don't try to parse the package version. The following will work on servers with and without CB relocation:
Java:
private static final String CRAFTBUKKIT_PACKAGE = Bukkit.getServer().getClass().getPackage().getName();
public static String cbClass(String className) {
return CRAFTBUKKIT_PACKAGE + "." + className);
}
Class.forName(cbClass("entity.CraftBee"))If you try to parse the server version
Do NOT do this:
Java:
String craftBukkitPackage = Bukkit.getServer().getClass().getPackage().getName();
// This is the *bad* part, including any other parsing of the version
String version = craftBukkitPackage.substring(craftBukkitPackage.lastIndexOf('.') + 1);
if (version.equals("v1_20_R3")) {
// ...
} else {
// Unsupported
}
Java:
// Paper method that was added in 2020
// Example value: 1.20.4
String minecraftVersion = Bukkit.getServer().getMinecraftVersion();
// Bukkit method that was added in 2011
// Example value: 1.20.4-R0.1-SNAPSHOT
String bukkitVersion = Bukkit.getServer().getBukkitVersion();
if (minecraftVersion.equals("1.20.4")) {
// ...
} else {
// Assume latest still works, or error as unsupported
// Alternatively for extra compatibility, check if
// the latest package version is valid by catching
// ClassNotFoundException with: Class.forName("org.bukkit.craftbukkit.v1_20_R3.CraftServer")
}Bukkit.getUnsafe.As a server owner
If you are running a somewhat recent server version with up-to-date plugins (!), you should also test whether your plugins are able to run on the test server jar also linked above. Please make sure not to use the server jar on your main servers, but to copy your plugin setup to a separate test server.The error that plugin developers need to fix will look something like this:
Alternatively, they might log an error saying you are using an unknown or unsupported server version.
If any of your plugins start printing new errors like these and you have made sure that they are already up-to-date, please report the error with a link to this announcement to the relevant plugin authors.
Last edited by a moderator:
