RyanDo at 09:43, 12 October 2025

2025-10-12T09:43:36Z

← Older revision		Revision as of 09:43, 12 October 2025
Line 1:		Line 1:
	~~[[BKCommonLib\|« Go back]]~~

	==Introduction==		==Introduction==
	To keep keep track of packets being sent between the server and the client, BKCommonLib provides a packet listener to intercept and handle these packets. When [https://www.spigotmc.org/resources/protocollib.1997/ ProtocolLib] is found, this plugin is used to provide the listening, otherwise a hacky workaround is used. We recommend you install ProtocolLib as well for that reason.		To keep keep track of packets being sent between the server and the client, BKCommonLib provides a packet listener to intercept and handle these packets. When [https://www.spigotmc.org/resources/protocollib.1997/ ProtocolLib] is found, this plugin is used to provide the listening, otherwise a hacky workaround is used. We recommend you install ProtocolLib as well for that reason.

RyanDo: Created page with "« Go back ==Introduction== To keep keep track of packets being sent between the server and the client, BKCommonLib provides a packet listener to intercept an..."

2021-06-09T18:55:39Z

Created page with "« Go back ==Introduction== To keep keep track of packets being sent between the server and the client, BKCommonLib provides a packet listener to intercept an..."

New page

[[BKCommonLib|« Go back]]

==Introduction==
To keep keep track of packets being sent between the server and the client, BKCommonLib provides a packet listener to intercept and handle these packets. When [https://www.spigotmc.org/resources/protocollib.1997/ ProtocolLib] is found, this plugin is used to provide the listening, otherwise a hacky workaround is used. We recommend you install ProtocolLib as well for that reason.

==Usage==
How to register a packet listener and how to read and change the packets.

==Registering==
Use the following method to register your [https://github.com/bergerkiller/BKCommonLib/blob/master/src/main/java/com/bergerkiller/bukkit/common/protocol/PacketListener.java PacketListener] implementing class:

<pre>PacketUtil.addPacketListener(plugin, myPacketListener, PacketType.OUT_CHAT);</pre>
To create a Packet listener class for your plugin, create a new Class that implements PacketListener, and override the '''onPacketReceive''' and '''onPacketSend''' methods. There are INcoming and OUTgoing Packet Types, they register for the methods respectively.

==Working with packets==
Packets change all the time, so it was not possible to include a wrapper class for each and every packet. To work with packets, BKCommonLib provides you a reflection-based system for accessing fields and constructing new packets, namely [https://github.com/bergerkiller/BKCommonLib/blob/master/src/main/java/com/bergerkiller/bukkit/common/protocol/PacketType.java PacketType]:

<pre>@Override
public void onPacketSend(PacketSendEvent event) {
CommonPacket packet = event.getPacket();
if (packet.getType() == PacketType.OUT_CHAT) {
String oldMessage = packet.read(PacketType.OUT_CHAT.message);
if (oldMessage.contains("curse")) {
packet.write(PacketType.OUT_CHAT.message, oldMessage.replace("curse", "curse is awesome"));
}
}
}</pre>
There are also methods to read/write a certain parameter index or by name, but they are generally unsafe. We recommend you use the PacketFields constants for this instead, so your plugin remains compatible when fields change. For example, if the 'message' String field is replaced with a List of Strings, we can still provide you with a (deprecated) message field which sets that other field.

BKCommonLib/Packets - Revision history

RyanDo at 09:43, 12 October 2025

RyanDo: Created page with "« Go back ==Introduction== To keep keep track of packets being sent between the server and the client, BKCommonLib provides a packet listener to intercept an..."