ProtocolLib
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
Development builds of ProtocolLib can be found here: https://ci.dmulloy2.net/job/ProtocolLib/
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 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 the following repository:
<repositories> <repository> <id>dmulloy2-repo</id> <url>https://repo.dmulloy2.net/content/groups/public/</url> </repository> <!-- And so on --> </repositories>
You can add it as a dependency like so:
<dependencies> <dependency> <groupId>com.comphenix.protocol</groupId> <artifactId>ProtocolLib</artifactId> <version>4.5.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):
- Connection side: Either client or server.
- Multiple ID ranges: Can be a single packet ID like 14, or a range like 10 - 15. Defaults to 0 - 255 if not specified.
- 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
Option | Default |
Description |
---|---|---|
auto updater.notify | true | Inform any player with the permission protocol.info when a new version of ProtocolLib is out. |
auto updater.download | true | Automatically download and install the newest version of ProtocolLib. The installation will take effect when the server restarts. |
auto updater.delay | 43200 | The number of seconds between each check for a new update. |
auto updater.last | 0 | This 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. |
metrics | true | If TRUE, ProtocolLib will publish anonymous usage data to mcstats.org. Set it to FALSE to opt-out. |
background compiler | true | If TRUE, ProtocolLib will try and improve performance by replacing reflection with compiled code on-the-fly. |
ignore version check | None | Force ProtocolLib to start for a specified Minecraft version, even if it is incompatible. |
suppressed reports | None | If 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 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
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
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.
Aw.
You now print off in console when I'm using a random plugin object to register my packet listener :(
What would you say is the most stable build to use for the Spigot 1.8 compatible version?
@libraryaddict
You definitely deserve more than one spot though. :P
But yeah, I'll combine them.
@aadnk
Why do we get two entries for donators?
Last time we checked, our dominant side didn't have another personality.
@libraryaddict
Oh, wow. Thank you so much. :D
Donated another hundred
Bad news.
Your spigot version of ProtocolLib doesn't like the dualbytes or so introduced by spigot for 1.7 and 1.8 compatibility.
Its used in DataWatchers and I found that out with a slew of nasty errors.
@aadnk Thank you very much aadnk !!!
"is only going to be in use until CraftBukkit is updated to 1.8." This period can be a long xD
@tommiek2
Good news, I've created a version of ProtocolLib that is compatible with the newest Spigot hack build.
You can find it on my Jenkins server under "ProtocolLib - Spigot Hack 1.8".
I decided to make this a separate build, like last time, as the Spigot hack is only going to be in use until CraftBukkit is updated to 1.8.
@aadnk
Removed. I am also a developer so I know how flustrating it when you are developing something and it takes some time and dozens of people ask (some with really bad gramar, unsure whenever on purpose) for ETA (even if you have explanation why no EAT as H1 heading on the main page). GL updating it.
@kangarkooo
Unfortunately, I have not had a chance to look at the new Spigot protocol hack yet, so I don't know exactly how long it would take to update ProtocolLib. I should have some time to look into this in a few hours.
I'll keep you apprised of my progress.
@kangarkooo
I don't mind if people ask for an ETA once, but I don't appreciate spam either.
I think you have to remove that link, though. I'm all for joking now and then, but you can't link to development builds without a disclaimer.
@kangarkooo
I almost laughed...-.-
@tommiek2
No ETA, approximately 2015. Thanks for being patient.
Hello Aadnk,
According to md_5, the creator of Spigot, ProtocolLib does not work with 1.8 (source: http://www.spigotmc.org/threads/protocollib-doesnt-work-with-latest-spigot-builds.28271/#post-316281). Spigot has been updated to support 1.8 clients as well as 1.7 clients. Is it possible to update ProtocolLib for 1.8? Me, and tons of other server owners would really appreciate it! :) I understand if it might take some time to update it, if it will, could you please give me/us an ETA? Thanks a lot in advance!
@BartkooPL
ProtocolLib - Cauldron on my Jenkins server should be compatible with that version.
What about Cauldron 1.7.2 ? :(
@XzKNIGHTzX
Mostly, but not all features are supported in 1.2.5, like WrappedServerPing. This is usually documented in the JavaDoc - for instance, every method in PacketContainer that is only for 1.7.2 and above contains the string "1.7.2" in the description.
"Use 3.4.0 for Minecraft 1.7.9/.7.2/1.6.4/1.6.2/1.5.2/1.4.7 and older" Does this mean I can use the 3.4.0 with Minecraft version 1.2.5 as an Api?
@asofold
2 is better then 1!
Blue is good right? I'm going to load up your latest build and see how it goes!