Bukkit

ProtocolLib

ProtocolLib has, for the most part, moved over to Spigot! If you need support, head over there!

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.

Links

• Spigot Resource Page
• JavaDoc for API
• Source Code
• Issue Tracker
• Support Forum
• Usage Statistics

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 issue tracker. 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 Maven Central. You can add it as a dependency like so:

<dependencies>
  <dependency>
    <groupId>net.dmulloy2</groupId>
    <artifactId>ProtocolLib</artifactId>
    <version>5.4.0</version>
  </dependency>
  <!-- And so on -->
</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

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 Minecraft. And the end result is quite good, 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.

(note that the below list hasn't been updated in ages and ymmv)

Plugins that appear to be compatible

• NoLagg
• NoCheatPlus

Plugins known to be compatible

• SpoutPlugin

Plugins using ProtocolLib

• Orebfuscator
• TagAPI
• DisguiseCraft
• VanishNoPacket (v3.18.5 and earlier)
• BkCommonLib
• CraftBook
• ChairsReloaded (3.0.2 and earlier)
• Scavenger
• TabAPI
• Individual-Signs
• ItemRenamer
• RandomCoords
• AntiCommandTab
• Sneaky
• Spy
• Statues
• Seasons
• Safe Command Block
• PlayerHider
• Phantasma Chat Filter
• Ghost Hunt
• ReMap
• AttributeHider
• uCars
• uPlanes
• PropHunt
• Portable-Horses
• ClickEdit
• RageBan
• ReChat
• PlayEffect
• FakePlayers
• PlayerCountMessage
• Vampire
• Murder
• NoSpy
• PingNachricht
• NoCheatPlus
• ScoreboardStats

Inactive projects

• InvisibilityViewer

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

Privacy

This plugin uses BStats 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.

Donating

If ProtocolLib has made your life significantly easier or you're feeling particularly generous, consider donating! It's a great way to support the many hours I've spent maintaining this plugin and keeps me motivated. Don't donate if you can't afford it.



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

Note: Create an issue if you're having problems. I generally don't check the BukkitDev comments.