ProtocolLib

ProtocolLib

Use 3.4.0 for Minecraft 1.7.10 and older

Use 3.6.x for Spigot 1.8

Users of MCPC-Plus 1.7.2 and above should look for a special build (ProtocolLib - MCPC 1.7.2) on my Jenkins server. Cauldron users should download ProtocolLib - Cauldron.

Certain tasks are impossible to perform with the standard Bukkit API, and may require working with and even modify Minecraft directly. A common technique is to modify incoming and outgoing packets, or inject custom packets into the stream. This is quite cumbersome to do, however, and most implementations will break as soon as a new version of Minecraft has been released, mostly due to obfuscation.

Critically, different plugins that use this approach may hook into the same classes, with unpredictable outcomes. More than often this causes plugins to crash, but it may also lead to more subtle bugs.

Up-to-date development builds of ProtocolLib can be found here: http://ci.shadowvolt.com/job/ProtocolLib/
Older development builds (and Cauldron builds) can be found here: http://assets.comphenix.net/
These builds have not been approved by the BukkitDev staff. Use them at your own risk.

Support

Please create a issue with as much information as possible if you experience a problem that has not already been reported. Comments with a huge stack trace will be deleted.

If you need help with the API, please use the Spigot discussion forum. If your question cannot be made public for whatever reason (including security bugs), send me a personal message instead.

For server operators

Just download ProtocolLib from the link above. It doesn't do anything on its own, it simply allows other plugins to function.

FAQ

  • Why do I get FieldAccessExceptions when I try to read or write from packets?
Quote:

The reason for these exceptions is because ProtocolLib is not using the packet format as described on the Wiki, it's using the in-memory representation of these packets. Often, the in-memory representation will use integers instead of shorts and bytes, and store more complex objects (like ItemStacks) directly.

You can figure out the in-memory representation from the Minecraft source code, or just use PacketWrapper where I've done all that work for you.

Examples

Source code for a bunch of example programs that use ProtocolLib can be found at this thread on the main support forum.

You may also be interested in PacketWrapper, a library that makes it possible to modify a packet without having to decompile the Minecraft source code.

Finally, for the more advanced users who want to use ProtocolLib if present, but still fall back on their own packet listening system, I recommend taking a look at this thread. I explain where and how to inject code into CraftBukkit in order to intercept sent and received packets yourself.

Maven repository

If you're using Maven, you'll be able to automatically download the JAR, JavaDoc and associated sources from the following repository:

<repositories>
  <repository>
    <id>shadowvolt-repo</id>
    <url>http://ci.shadowvolt.com/plugin/repository/everything/</url>
  </repository>
<!-- And so on -->
</repositories>

This repository contains ProtocolLib, TagHelper and BlockPatcher. You can add any of them as a dependency like so:

<dependencies>
  <dependency>
    <groupId>com.comphenix.protocol</groupId>
    <artifactId>ProtocolLib</artifactId>
    <version>3.6.3-SNAPSHOT</version>
  </dependency>
</dependencies>

Commands

Protocol

Main administrative command. Supports the following sub-commands:

  • config: Reload the configuration file.
  • check: Check for new versions on BukkitDev.
  • update: Check for new versions and automatically download the JAR. The server must be restarted for this to take effect.
  • timings: Toggle measuring the amount of CPU time spent by each plugin. See here for more information.
  • listeners: Display what plugins are using ProtocolLib, and the packet types they are intercepting.

All of these commands require the permission protocol.admin.

Example:

/protocol update

Packet

Add or remove a debug packet listener. This is useful for plugin authors who just wants to see when a packet is sent, and with what content.

Sub commands:

  • add: Add a packet listener with a given packet ID.
  • remove: Remove one or every packet listener with the given packet IDs.
  • names: Print the name of every given packet ID.

Parameters (in order):

  1. Connection side: Either client or server.
  2. Multiple ID ranges: Can be a single packet ID like 14, or a range like 10 - 15. Defaults to 0 - 255 if not specified.
  3. Detailed: If TRUE, prints the full packet content.

Example:

/packet add client 10-13 true

For 3.0.0 and above, you should specify the protocol, sender and name instead:

/packet add play server chat true

In 3.4.0-SNAPSHOT and above, you can also display the packet before its modified by any packet listeners:

/packet add play server chat compare

Remove all listeners:

/packet remove client
/packet remove server

Note that this command should rarely be used on a production server. Listening to too many packets may crash the server.

Filter

The filter system (introduced in 2.4.1) uses the built in JavaScript interpreter in JVM 6 (Rhino) to extend the packet command with filtering capabilities - it is now possible to, say, only print entity metadata packet events (packet add server 40) for a given entity ID:

> packet add server 40 true
Added listener ListeningWhitelist{priority=MONITOR, packets=[40]}
> filter add entity_filter 40
Enter filter program ('}' to complete or CANCEL):
function(event, packet) {
>   return packet.a == 1000; 
>}
Added filter entity_filter.

This should be much more convenient than having to compile a test plugin and reload the whole server. Note that this feature is disabled by default for security reasons. To enable it, add "debug: true" to config.yml.

Configuration

A small set of configuration options are available:

Global section

OptionDefault

Description

auto updater.notifytrueInform any player with the permission protocol.info when a new version of ProtocolLib is out.
auto updater.downloadtrueAutomatically download and install the newest version of ProtocolLib. The installation will take effect when the server restarts.
auto updater.delay43200The number of seconds between each check for a new update.
auto updater.last0This simply records the last time (in seconds since 01.01.1970) an update check was performed. Set it to 0 to force a new update check.
metricstrueIf TRUE, ProtocolLib will publish anonymous usage data to mcstats.org. Set it to FALSE to opt-out.
background compilertrueIf TRUE, ProtocolLib will try and improve performance by replacing reflection with compiled code on-the-fly.
ignore version checkNoneForce ProtocolLib to start for a specified Minecraft version, even if it is incompatible.
suppressed reportsNoneIf any error or warning report is present in this list, they will not appear in the console or the log.

For more information, take a look at the default configuration file.

Tutorial for developers

See this page for more information.

Compatibility

One of the main goals of this project was to achieve maximum compatibility with CraftBukkit. And the end result is quite good - in tests I successfully ran an unmodified ProtocolLib on CraftBukkit 1.8.0, and it should be resilient against future changes. It's likely that I won't have to update ProtocolLib for anything but bug and performance fixes.

How is this possible? It all comes down to reflection in the end. Essentially, no name is hard coded - every field, method and class is deduced by looking at field types, package names or parameter types. It's remarkably consistent across different versions.

Plugins that appear to be compatible

Plugins known to be compatible

  • SpoutPlugin

Plugins using ProtocolLib

Inactive projects

Please let me know if you want me to add your plugin to this list. :)

Privacy

This plugin uses MCStats to generate and publish anonymous aggregate usage statistics, but you can easily opt-out by setting metrics in config.yml to false.

If enabled, the following is sent every ten minutes:

  • Metrics revision version (currently 6).
  • Server's GUID
  • Players currently online (not max player count)
  • Server version string (the same version string you see in /version)
  • Current version of ProtocolLib
  • The name of every plugin that registers a packet listener in ProtocolLib.

Acknowledgements

I would like to thank everyone who has donated to ProtocoLib. I really appreciate it. :)

Statistics

ProtocolLib Statistics

Note: Create an issue if you're having problems. Don't post stack traces in the comments.

You must login to post a comment. Don't have an account? Register to get one!

  • Avatar of matgsan matgsan Jan 25, 2015 at 17:38 UTC - 0 likes

    There is a way to spawn Fake Players in 1.5.2? If yes, how so?

    pvp.craftcube.com.br BFAK:90981295,38933b8e13c35bd659ca85699ade08cbe6ebf6e7a9154e59b7eae0a36d9ebc63

  • Avatar of aadnk aadnk Jan 23, 2015 at 17:08 UTC - 0 likes

    @gacus007: Go

    Try setting "debug" to false and debug: false "detailed error" false in the configuration file.

    The "error" itself simply means that a player has disconnected from the server (hence ClosedChannelException), so if you're having problems, this is not the cause.

  • Avatar of gacus007 gacus007 Jan 16, 2015 at 19:59 UTC - 0 likes

    HI ,J've problem with : An exceptionCaught() event was fired, and it reached at the tail of the pipeline. It usually means the last handler in the pipeline did not handle the exception. java.nio.channels.ClosedChannelException

    Server sometmies turn off after 1h -2 h works.

    My version protocol lib : 3.4.0

  • Avatar of BFUSpEd BFUSpEd Jan 15, 2015 at 09:55 UTC - 0 likes

    Trying to display the enchantment glow for any item containing the "enchantment" string in the lore, but its somehow only working for leather armor.

    code: http://pastebin.com/gsa2kuz3 result: http://ibin.co/1oDRFNfJ2xjw

    using spigot 1.8 build 18 and ProtocolLib build 72. tested with no other plugins installed and same issue.

  • Avatar of TiREXuPL TiREXuPL Jan 10, 2015 at 17:14 UTC - 0 likes

    Please help me with crash: http://pastebin.com/eE2YTyTK

    I have ProtocolLib 3.6.0-SNAPSHOT md_5 send me and referrals this version.

  • Avatar of aadnk aadnk Jan 09, 2015 at 16:44 UTC - 1 like

    @keelos123: Go

    TagAPI does not work in 1.8.0 (and probably never will).

  • Avatar of davidrch davidrch Jan 05, 2015 at 13:45 UTC - 0 likes

    Hey anyone can help i saw this is optional for statues plugin but this plugin can help with what i want, im needing that statues mob or player etc...sells something like a villiager but with statues and not exchanges HELP ME IM DESESPERATE

  • Avatar of dmulloy2 dmulloy2 Jan 04, 2015 at 22:37 UTC - 0 likes

    @thedeadprince: Go

    Make sure you're using the latest development build from here: http://ci.shadowvolt.com/job/ProtocolLib/

    Note: These builds have not been approved by the BukkitDev staff. Use them at your own risk.

  • Avatar of thedeadprince thedeadprince Jan 04, 2015 at 05:09 UTC - 0 likes

    Hi there i keep getting this message at the moment, please can this be fixed as soon as possible.

    [05:07:18 ERROR]: [ProtocolLib] INTERNAL ERROR: Cannot enable ProtocolLib. If this problem hasn't already been reported, please open a ticket at http://dev.bukkit.org/server-mods/protocollib/ with the following data:

    STACK TRACE

    java.lang.NoClassDefFoundError: Could not initialize class com.comphenix.protocol.utility.MinecraftReflection at com.comphenix.protocol.injector.packet.PacketRegistry.initialize(PacketRegistry.java:78) at com.comphenix.protocol.injector.packet.PacketRegistry.getPacketClassFromType(PacketRegistry.java:356) at com.comphenix.protocol.utility.ChatExtensions.getJsonFormatConstructor(ChatExtensions.java:218) at com.comphenix.protocol.utility.ChatExtensions.<clinit>(ChatExtensions.java:56) at com.comphenix.protocol.ProtocolLibrary.onEnable(ProtocolLibrary.java:377) at org.bukkit.plugin.java.JavaPlugin.setEnabled(JavaPlugin.java:316) at org.bukkit.plugin.java.JavaPluginLoader.enablePlugin(JavaPluginLoader.java:333) at org.bukkit.plugin.SimplePluginManager.enablePlugin(SimplePluginManager.java:412) at org.bukkit.craftbukkit.v1_8_R1.CraftServer.loadPlugin(CraftServer.java:352) at org.bukkit.craftbukkit.v1_8_R1.CraftServer.enablePlugins(CraftServer.java:313) at org.bukkit.craftbukkit.v1_8_R1.CraftServer.reload(CraftServer.java:741) at be.Balor.Manager.Commands.Server.ReloadAll$1.run(ReloadAll.java:59) at org.bukkit.craftbukkit.v1_8_R1.scheduler.CraftTask.run(CraftTask.java:71) at org.bukkit.craftbukkit.v1_8_R1.scheduler.CraftScheduler.mainThreadHeartbeat(CraftScheduler.java:350) at net.minecraft.server.v1_8_R1.MinecraftServer.z(MinecraftServer.java:695) at net.minecraft.server.v1_8_R1.DedicatedServer.z(DedicatedServer.java:316) at net.minecraft.server.v1_8_R1.MinecraftServer.y(MinecraftServer.java:625) at net.minecraft.server.v1_8_R1.MinecraftServer.run(MinecraftServer.java:528) at java.lang.Thread.run(Thread.java:745)

    DUMP

    Sender: com.comphenix.protocol.ProtocolLibrary@29537beb[ statistisc=<null> backgroundCompiler=<null> packetTask=-1 tickCounter=0 unhookTask=com.comphenix.protocol.injector.DelayedSingleTask@2ca4734b configExpectedMod=-1 updater=com.comphenix.protocol.metrics.Updater@608d57d2 logger=org.bukkit.plugin.PluginLogger@5f80cd83 redirectHandler=<null> commandProtocol=<null> commandPacket=<null> commandFilter=<null> skipDisable=false isEnabled=true loader=org.bukkit.plugin.java.JavaPluginLoader@1348471 server=CraftServer{serverName=CraftBukkit,serverVersion=git-Spigot-a6b08a3,minecraftVersion=1.8} file=plugins/ProtocolLib.jar description=org.bukkit.plugin.PluginDescriptionFile@1ee31755 dataFolder=plugins/ProtocolLib classLoader=org.bukkit.plugin.java.PluginClassLoader@212b4009 naggable=true ebean=<null> newConfig=YamlConfiguration[path='', root='YamlConfiguration'] configFile=plugins/ProtocolLib/config.yml logger=org.bukkit.plugin.PluginLogger@5f80cd83 ] Version: ProtocolLib v3.4.0 Server: git-Spigot-a6b08a3 (MC: 1.8)

Facts

Date created
Oct 05, 2012
Category
Last update
Jun 15, 2014
Development stage
Release
Language
  • enUS
License
GNU General Public License version 2 (GPLv2)
Curse link
ProtocolLib
Downloads
1,207,832
Recent files

Authors