From dd19e1040a7ee8a04f8b39bf46f0a038dd582582 Mon Sep 17 00:00:00 2001 From: Pasqual Koschmieder Date: Thu, 7 Jul 2022 09:49:41 +0200 Subject: [PATCH] [ci skip] cleanup & improve readme a bit (#1724) * [ci skip] cleanup & improve readme a bit * [ci skip] improve code indention --- Readme.md | 94 +++++++++++++++++++++++++++---------------------------- 1 file changed, 46 insertions(+), 48 deletions(-) diff --git a/Readme.md b/Readme.md index 900b6f3a..f1ccef0e 100644 --- a/Readme.md +++ b/Readme.md @@ -1,7 +1,7 @@ # ProtocolLib 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 +working with and even modifying Minecraft directly. A common technique is to modify incoming and outgoing [packets](https://www.wiki.vg/Protocol), 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. @@ -16,15 +16,16 @@ Currently maintained by dmulloy2 on behalf of [Spigot](https://www.spigotmc.org/ * [Resource Page](https://www.spigotmc.org/resources/protocollib.1997/) * [Dev Builds](https://ci.dmulloy2.net/job/ProtocolLib) -* [JavaDoc](https://ci.dmulloy2.net/job/ProtocolLib/javadoc) +* [JavaDoc](https://ci.dmulloy2.net/job/ProtocolLib/javadoc/index.html) ### Compilation -ProtocolLib is built with Maven and requires Spigot and SpigotAPI, which can be found [here](https://www.spigotmc.org/wiki/buildtools/). +ProtocolLib is built with [Maven](https://maven.apache.org/). If you have it installed, just run +`mvn package` in the root project folder. ### A new API -__ProtocolLib__ attempts to solve this problem by providing a event API, much like Bukkit, +__ProtocolLib__ attempts to solve this problem by providing an event API, much like Bukkit, that allows plugins to monitor, modify, or cancel packets sent and received. But, more importantly, the API also hides all the gritty, obfuscated classes with a simple index based read/write system. You no longer have to reference CraftBukkit! @@ -35,7 +36,7 @@ To use this library, first add ProtocolLib.jar to your Java build path. Then, ad as a dependency or soft dependency to your plugin.yml file like any other plugin: ````yml -depend: [ProtocolLib] +depend: [ ProtocolLib ] ```` You can also add ProtocolLib as a Maven dependency: @@ -46,7 +47,6 @@ You can also add ProtocolLib as a Maven dependency: dmulloy2-repo https://repo.dmulloy2.net/repository/public/ - ... @@ -54,6 +54,7 @@ You can also add ProtocolLib as a Maven dependency: com.comphenix.protocol ProtocolLib 4.7.0 + provided ```` @@ -84,16 +85,14 @@ To listen for packets sent by the server to a client, add a server-side listener ````java // Disable all sound effects -protocolManager.addPacketListener( - new PacketAdapter(this, ListenerPriority.NORMAL, - PacketType.Play.Server.NAMED_SOUND_EFFECT) { +protocolManager.addPacketListener(new PacketAdapter( + this, + ListenerPriority.NORMAL, + PacketType.Play.Server.NAMED_SOUND_EFFECT +) { @Override public void onPacketSending(PacketEvent event) { - // Item packets (id: 0x29) - if (event.getPacketType() == - PacketType.Play.Server.NAMED_SOUND_EFFECT) { - event.setCancelled(true); - } + event.setCancelled(true); } }); ```` @@ -103,20 +102,19 @@ censor by listening for Packet3Chat events: ````java // Censor -protocolManager.addPacketListener(new PacketAdapter(this, - ListenerPriority.NORMAL, - PacketType.Play.Client.CHAT) { +protocolManager.addPacketListener(new PacketAdapter( + this, + ListenerPriority.NORMAL, + PacketType.Play.Client.CHAT +) { @Override public void onPacketReceiving(PacketEvent event) { - if (event.getPacketType() == PacketType.Play.Client.CHAT) { - PacketContainer packet = event.getPacket(); - String message = packet.getStrings().read(0); + PacketContainer packet = event.getPacket(); + String message = packet.getStrings().read(0); - if (message.contains("shit") - || message.contains("damn")) { - event.setCancelled(true); - event.getPlayer().sendMessage("Bad manners!"); - } + if (message.contains("shit") || message.contains("damn")) { + event.setCancelled(true); + event.getPlayer().sendMessage("Bad manners!"); } } }); @@ -127,42 +125,42 @@ protocolManager.addPacketListener(new PacketAdapter(this, Normally, you might have to do something ugly like the following: ````java -Packet60Explosion fakeExplosion = new Packet60Explosion(); +PacketPlayOutExplosion fakeExplosion = new PacketPlayOutExplosion( + player.getLocation().getX(), + player.getLocation().getY(), + player.getLocation().getZ(), + 3.0F, + new ArrayList<>(), + new Vec3D( + player.getVelocity().getX() + 1, + player.getVelocity().getY() + 1, + player.getVelocity().getZ() + 1 + ) +); -fakeExplosion.a = player.getLocation().getX(); -fakeExplosion.b = player.getLocation().getY(); -fakeExplosion.c = player.getLocation().getZ(); -fakeExplosion.d = 3.0F; -fakeExplosion.e = new ArrayList(); - -((CraftPlayer) player).getHandle().netServerHandler.sendPacket(fakeExplosion); +((CraftPlayer) player).getHandle().b.a(fakeExplosion); ```` -But with ProtocolLib, you can turn that into something more manageable. Notice that -you don't have to create an ArrayList with this version: +But with ProtocolLib, you can turn that into something more manageable: ````java - PacketContainer fakeExplosion = new PacketContainer(PacketType.Play.Server.EXPLOSION); -fakeExplosion.getDoubles(). - write(0, player.getLocation().getX()). - write(1, player.getLocation().getY()). - write(2, player.getLocation().getZ()); +fakeExplosion.getDoubles() + .write(0, player.getLocation().getX()) + .write(1, player.getLocation().getY()) + .write(2, player.getLocation().getZ()); fakeExplosion.getFloat().write(0, 3.0F); +fakeExplosion.getBlockPositionCollectionModifier().write(0, new ArrayList<>()); +fakeExplosion.getVectors().write(0, player.getVelocity().add(new Vector(1, 1, 1))); -try { - protocolManager.sendServerPacket(player, fakeExplosion); -} catch (InvocationTargetException e) { - throw new RuntimeException( - "Cannot send packet " + fakeExplosion, e); -} +protocolManager.sendServerPacket(player, fakeExplosion); ```` ### Compatibility One of the main goals of this project was to achieve maximum compatibility with CraftBukkit. And the end -result is quite flexible. Aside from netty package changes, it should be resilient against future changes. -It's likely that I won't have to update ProtocolLib for anything but bug fixes and new features. +result is quite flexible. It's likely that I won't have to update ProtocolLib for anything but bug fixes +and new features. 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