Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Exceptionflug/protocolize
A lightweight BungeeCord / Velocity protocol framework supporting items
https://github.com/Exceptionflug/protocolize
Last synced: about 2 months ago
JSON representation
A lightweight BungeeCord / Velocity protocol framework supporting items
- Host: GitHub
- URL: https://github.com/Exceptionflug/protocolize
- Owner: Exceptionflug
- License: mit
- Created: 2018-09-28T22:56:34.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-10-23T17:47:32.000Z (3 months ago)
- Last Synced: 2024-10-24T01:53:09.848Z (3 months ago)
- Language: Java
- Homepage:
- Size: 1.36 MB
- Stars: 297
- Watchers: 7
- Forks: 38
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-minecraft - Protocolize - A lightweight BungeeCord / Velocity protocol framework supporting items. (Protocol)
README
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](https://github.com/Exceptionflug/protocolize/tree/v1).
## 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
```xml
exceptionflug
https://mvn.exceptionflug.de/repository/exceptionflug-public/
```
```xml
dev.simplix
protocolize-api
2.4.2
provided
```
**Or alternatively, with Gradle:**
```kotlin
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](https://ci.exceptionflug.de/job/Protocolize-Legacy-Data/)) |
| 1.13 - 1.13.2 | ✔️ (Sounds only with [additional legacy module](https://ci.exceptionflug.de/job/Protocolize-Legacy-Data/)) |
| 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](https://discord.gg/ZsYjwcNRbV).