![](\"https:\/\/raw.githubusercontent.com\/MrNavaStar\/ProtoWeaver\/master\/server\/src\/main\/resources\/assets\/protoweaver\/icon.png\"){kind=icon}
<\/p>\n
\n<\/p>\n
<\/p>\n
<\/p>\n
# ProtoWeaver
\nA minecraft networking library for creating custom protocols that run on the internal netty server. <\/p>\n
#### What dis mean?
\nSick and tired of hyjacking client connections to send data to and from a proxy? Well I sure was. ProtoWeaver allows you to create a custom protocol that runs on the same port that the minecraft server uses.
\nThis means a proxy such as velocity is able to communicate with the server regardless if players are on online or not, without running an extra socket server on a different port. Protoweaver is also not just
\nlimited to proxies. Using the `client` module, any 3rd party java application can talk directly with ProtoWeaver!<\/p>\n
Protoweaver is fast, secure, and easy to use. All protocols run under the same netty instance used by minecraft, are encypted with ssl, and are wrapped in a very straight forward api. Lets take a look:<\/p>\n
### Features
\n– [x] Zero user config required
\n– [x] SSL encrytion
\n– [x] Protocol authentication
\n– [x] Packets as POJO’s
\n– [x] Compression (Gzip, Snappy, LZ)
\n– [x] All major mod loaders (neoforge soon tm)
\n– [ ] API for registering raw protocols (http, ssh, etc)
\n– [x] Custom serialization
\n– [ ] Custom SSL providers\/certs
\n– [ ] Muti-protocol connections
\n– [ ] Tell me what you want to see!<\/p>\n
### Project Setup
\nIn your build.gradle include<\/p>\n
*** Note: **Do not shade protoweaver! It will not work properly. ProtoWeaver is a mod\/plugin that is installed along side yours!**
\n“` gradle
\nrepositories {
\n maven { url “https:\/\/maven.mrnavastar.me\/releases” }
\n}<\/p>\n
dependencies {
\n \/\/ ‘common’ can be replaced with any of: `client`, `fabric`, `forge`, `paper` or `proxy`.
\n implementation “me.mrnavastar.protoweaver:common:1.3.11”
\n}
\n“`<\/p>\n
### Creating a Protocol
\nProtocols are very customizable with a lot of built in functionality. Here is an example protocol:
\n“`java
\nProtocol protocol = Protocol.create(“my_mod_id”, “cool_protocol”)
\n .setCompression(CompressionType.GZIP)
\n .setServerHandler(MyCustomServerHandler.class)
\n .setClientHandler(MyCustomClientHandler.class)
\n .setMaxConnections(15)
\n .addPacket(String.class)
\n .build();<\/p>\n
\/\/ Load the protocol before it can be used
\nProtoWeaver.load(protocol);
\n“`<\/p>\n
### Sending packets
\nSending packets is extremely simple. Any POJO that has been added to the protocol (See [Creating a Protcol](#creating-a-protocol)) is a valid packet that can be sent. Note that all POJO serialization is handled through kyro, a fast and fast serialization library.
\n“`java
\n\/\/ If you have a reference to a ‘ProtoConnection’, you can simply:
\nconnection.send(myObject);
\n\/\/ If you have a reference to a ‘ProtoClient’, you can also:
\nclient.send(myObject);
\n“`<\/p>\n
### Handling packets
\nAll protocols need handlers in order to implement functionality. The client and server can either use the same handler, or both use different ones.
\n“`java
\npublic class MyCustomServerHandler implements ProtoConnectionHandler {
\n \/\/ Note that all functions are optional to implement<\/p>\n
@Override
\n public void void onReady(ProtoConnection connection) {
\n System.out.println(“awesome! looks like a new client has connected from: ” + connection.getRemoteAddress());
\n }<\/p>\n
@Override
\n public void onDisconnect(ProtoConnection connection) {
\n System.out.println(“goodbye: ” + connection.getRemoteAddress());
\n }<\/p>\n
@Override
\n public void handlePacket(ProtoConnection connection, Object packet) {
\n System.out.println(“wow! got: ” + packet.toString() + ” from: ” + connection.getRemoteAddress());
\n }
\n}
\n“`<\/p>\n
“`java
\npublic class MyCustomClientHandler implements ProtoConnectionHandler {
\n \/\/ Note that all functions are optional to implement<\/p>\n
@Override
\n public void void onReady(ProtoConnection connection) {
\n System.out.println(“awesome! connected to: ” + connection.getRemoteAddress());
\n }<\/p>\n
@Override
\n public void onDisconnect(ProtoConnection connection) {
\n System.out.println(“goodbye: ” + connection.getRemoteAddress());
\n }<\/p>\n
@Override
\n public void handlePacket(ProtoConnection connection, Object packet) {
\n System.out.println(“saying hi!”);
\n connection.send(“Hey server!”);
\n }
\n}
\n“`<\/p>\n
### Custom Serialization
\nSometimes it can be useful to send minecraft objects or other premade POJO’s in your protocol. To allow this, you can register a custom serializer.<\/p>\n
For example, here is a serializer for NBT tags: public NbtSerializer(Class @Override @Override ### More Docs Coming soon! Maybe a real website??<\/p>\n","protected":false},"excerpt":{"rendered":" A networking library for creating custom protocols that run on the internal netty server.<\/p>\n","protected":false},"featured_media":125811,"template":"","meta":{"_minecraft_slug":"protoweaver","_minecraft_project_id":"6nKmUVc7","_minecraft_author":"mrnavastar","_minecraft_license":"CC0-1.0","_minecraft_downloads":5265,"_minecraft_follows":25,"_minecraft_client_side":"unknown","_minecraft_server_side":"unknown","_minecraft_storage_type":"zip","_minecraft_archive_name":"protoweaver.zip","_minecraft_size_bytes":980587002,"_minecraft_version_count":134,"_minecraft_updated_at":"2026-05-16T03:22:36.703621Z","_minecraft_date_created":"2024-05-28T20:44:14.440160Z","_minecraft_date_modified":"2026-04-01T17:51:42.345830Z","_minecraft_project_url":"https:\/\/modrinth.com\/mod\/protoweaver","_minecraft_icon_attachment_id":125811,"_minecraft_imported_at":"2026-06-07T09:23:31+00:00","_minecraft_import_hash":"cf99e56964e60462b9bca07976625ff6","_minecraft_versions":"","_minecraft_links":"","_minecraft_gallery":"","_minecraft_api_metadata":""},"mod_category":[97,125,104,873,126,158,127,128,98,123,92,985,992],"mod_loader":[99,131,132,133,100],"minecraft_version":[110,111,112,113,114,115,116,117,118,119,120,46,47,48,49,50,51,52,53,54,55,56,57,58,59,36,60,93,94,101,102,62,37,40,41,73,74,38,78,79,80,81,82,83,167],"class_list":["post-125810","mod","type-mod","status-publish","has-post-thumbnail","hentry","mod_category-fabric","mod_category-folia","mod_category-forge","mod_category-library","mod_category-management","mod_category-neoforge","mod_category-paper","mod_category-purpur","mod_category-quilt","mod_category-technology","mod_category-utility","mod_category-velocity","mod_category-waterfall","mod_loader-fabric","mod_loader-folia","mod_loader-paper","mod_loader-purpur","mod_loader-quilt","minecraft_version-1-14","minecraft_version-1-14-1","minecraft_version-1-14-2","minecraft_version-1-14-3","minecraft_version-1-14-4","minecraft_version-1-15","minecraft_version-1-15-1","minecraft_version-1-15-2","minecraft_version-1-16","minecraft_version-1-16-1","minecraft_version-1-16-2","minecraft_version-1-16-3","minecraft_version-1-16-4","minecraft_version-1-16-5","minecraft_version-1-17","minecraft_version-1-17-1","minecraft_version-1-18","minecraft_version-1-18-1","minecraft_version-1-18-2","minecraft_version-1-19","minecraft_version-1-19-1","minecraft_version-1-19-2","minecraft_version-1-19-3","minecraft_version-1-19-4","minecraft_version-1-20","minecraft_version-1-20-1","minecraft_version-1-20-2","minecraft_version-1-20-3","minecraft_version-1-20-4","minecraft_version-1-20-5","minecraft_version-1-20-6","minecraft_version-1-21","minecraft_version-1-21-1","minecraft_version-1-21-10","minecraft_version-1-21-11","minecraft_version-1-21-2","minecraft_version-1-21-3","minecraft_version-1-21-4","minecraft_version-1-21-5","minecraft_version-1-21-6","minecraft_version-1-21-7","minecraft_version-1-21-8","minecraft_version-1-21-9","minecraft_version-26-1","minecraft_version-26-1-1"],"yoast_head":"\n
\n“`java
\npublic class NbtSerializer extends ProtoSerializer
\n super(type);
\n }<\/p>\n
\n public void write(ByteArrayOutputStream buffer, CompoundTag value) {
\n try {
\n NbtIo.writeCompressed(value, buffer);
\n } catch (IOException e) {
\n Platform.throwException(e);
\n }
\n }<\/p>\n
\n public CompoundTag read(ByteArrayInputStream buffer) {
\n try {
\n return NbtIo.readCompressed(buffer, NbtAccounter.unlimitedHeap());
\n } catch (IOException e) {
\n Platform.throwException(e);
\n throw new RuntimeException(e);
\n }
\n }
\n}
\n“`
\nThen to register the serializer, simply do:
\n“`java
\nProtocol protocol = Protocol.create(“my_mod_id”, “cool_protocol”)
\n .setCompression(CompressionType.GZIP)
\n .setServerHandler(MyCustomServerHandler.class)
\n .setClientHandler(MyCustomClientHandler.class)
\n .setMaxConnections(15)
\n .addPacket(CompoundTag.class, NbtSerializer.class)
\n .build();
\n“`<\/p>\n