Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Exceptionflug authored Mar 23, 2024
1 parent 721b352 commit 493cf9f
Showing 1 changed file with 5 additions and 11 deletions.
16 changes: 5 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,10 @@
# 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).

## Why a complete recode?
Protocolize v1 was already a successful approach on how to interact with the Minecraft protocol. The downsides were severe: An outdated code base that was hard to maintain and only supported BungeeCord. All those reasons resulted in the making of an whole new fresh code base that supports Velocity and that also takes a new approach on how to provide mappings for all supported protocol mappings.

### Migration
We provide some documentation on how to migrate your existing plugin to use the new Protocolize v2 API. [Click here](https://github.com/Exceptionflug/protocolize/wiki/Migrating-from-Protocolize-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
<repository>
Expand Down Expand Up @@ -47,8 +44,6 @@ dependencies {
compileOnly("dev.simplix:protocolize-api:2.3.3")
}
```
### Install the plugin
In order to use Protocolize, you have to install it onto your proxy server. Protocolize is supporting BungeeCord and Velocity proxy servers.

## Compatibility

Expand Down Expand Up @@ -82,9 +77,8 @@ Implemented packets by default:
You can easily add support for new packets and versions by installing modules.


## FAQ
You're experiencing uncommon packet errors and have ViaVersion/ViaBackwards installed on your proxy?
This is likely caused by some bugs in those plugins. We recomment you to only install them on your sub-server when usign Protocolize.
## Known issues
- Protocolize is unstable when being used with **proxy installations** of Geyser and/or ViaVersion.

## Get some help
For documentation take a look at the wiki pages.
Expand Down

0 comments on commit 493cf9f

Please sign in to comment.