Skip to content

Latest commit

 

History

History
85 lines (73 loc) · 3.88 KB

README.md

File metadata and controls

85 lines (73 loc) · 3.88 KB
Raw


Next generation protocol manipulation framework for proxy servers.

Protocolize v2

This is the official repository for the next generation proxy server protocol manipulation framework. If you wish to see the repository for Protocolize v1, click here.

Getting started

Installation

In order to use Protocolize, you have to install it onto your proxy server. Protocolize is supporting BungeeCord and Velocity proxy servers. Download the latest protocolize version for your proxy software right here: https://exceptionflug.de/protocolize.

Maven dependency and repository

<repository>
    <id>exceptionflug</id>
    <url>https://mvn.exceptionflug.de/repository/exceptionflug-public/</url>
</repository>
<dependency>
    <groupId>dev.simplix</groupId>
    <artifactId>protocolize-api</artifactId>
    <version>2.4.2</version>
    <scope>provided</scope>
</dependency>

Or alternatively, with Gradle:

repsitories {
    maven {
        url = uri('https://mvn.exceptionflug.de/repository/exceptionflug-public/')
    }
}

dependencies {
    compileOnly("dev.simplix:protocolize-api:2.4.1")
}

Compatibility

Protocolize is shipped with it's default data module which adds support for the following versions:

Minecraft Version Supported
1.8.x - 1.12.2 ❌ (Only with additional legacy module)
1.13 - 1.13.2 ✔️ (Sounds only with additional legacy module)
1.14 - 1.21 ✔️

Implemented packets by default:

Packet Class
Player block placement dev.simplix.protocolize.data.packets.BlockPlacement
Inventory click dev.simplix.protocolize.data.packets.ClickWindow
Close inventory dev.simplix.protocolize.data.packets.CloseWindow
Confirm transaction dev.simplix.protocolize.data.packets.ConfirmTransaction
Held item change dev.simplix.protocolize.data.packets.HeldItemChange
Named sound effect dev.simplix.protocolize.data.packets.NamedSoundEffect
Sound effect dev.simplix.protocolize.data.packets.SoundEffect
Open inventory dev.simplix.protocolize.data.packets.OpenWindow
Player look update dev.simplix.protocolize.data.packets.PlayerLook
Player position update dev.simplix.protocolize.data.packets.PlayerPosition
Player position and look update dev.simplix.protocolize.data.packets.PlayerPositionLook
Player slot update dev.simplix.protocolize.data.packets.SetSlot
Player item interaction dev.simplix.protocolize.data.packets.UseItem
Inventory items dev.simplix.protocolize.data.packets.WindowItems
Inventory properties dev.simplix.protocolize.data.packets.WindowProperty

You can easily add support for new packets and versions by installing modules.

Known issues

  • Protocolize is unstable when being used with proxy installations of Geyser / Floodgate and/or ViaVersion.

Get some help

For documentation take a look at the wiki pages. If you have questions feel free to join our discord server.