Skip to content

Commit b53933c

Browse files
committed
Update README.md
1 parent a3b3ade commit b53933c

File tree

1 file changed

+29
-9
lines changed

1 file changed

+29
-9
lines changed

README.md

Lines changed: 29 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
21
<div align=center>
32
<img src="./protocolize-logo.webp" width="512">
43
<br/><br/>
@@ -11,32 +10,46 @@
1110
</div>
1211

1312
# Protocolize v2
14-
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).
13+
14+
This is the official repository for the next generation proxy server protocol manipulation framework. If you wish to see
15+
the repository for Protocolize v1, click [here](https://github.com/Exceptionflug/protocolize/tree/v1).
1516

1617
## Why a complete recode?
17-
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.
18+
19+
Protocolize v1 was already a successful approach on how to interact with the Minecraft protocol. The downsides were
20+
severe: An outdated code base that was hard to maintain and only supported BungeeCord. All those reasons resulted in the
21+
making of an whole new fresh code base that supports Velocity and that also takes a new approach on how to provide
22+
mappings for all supported protocol mappings.
1823

1924
### Migration
20-
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).
25+
26+
We provide some documentation on how to migrate your existing plugin to use the new Protocolize v2
27+
API. [Click here](https://github.com/Exceptionflug/protocolize/wiki/Migrating-from-Protocolize-v1).
2128

2229
## Getting started
30+
2331
### Maven dependency and repository
32+
2433
```xml
34+
2535
<repository>
2636
<id>exceptionflug</id>
2737
<url>https://mvn.exceptionflug.de/repository/exceptionflug-public/</url>
2838
</repository>
2939
```
40+
3041
```xml
42+
3143
<dependency>
3244
<groupId>dev.simplix</groupId>
3345
<artifactId>protocolize-api</artifactId>
34-
<version>2.2.2</version>
3546
<version>2.2.3</version>
3647
<scope>provided</scope>
3748
</dependency>
3849
```
50+
3951
**Or alternatively, with Gradle:**
52+
4053
```kotlin
4154
repsitories {
4255
maven {
@@ -48,15 +61,20 @@ dependencies {
4861
compileOnly("dev.simplix:protocolize-api:2.2.2")
4962
}
5063
```
64+
5165
### Install the plugin
52-
In order to use Protocolize, you have to install it onto your proxy server. Protocolize is supporting BungeeCord and Velocity proxy servers.
66+
67+
In order to use Protocolize, you have to install it onto your proxy server. Protocolize is supporting BungeeCord and
68+
Velocity proxy servers.
5369

5470
## Compatibility
71+
5572
Protocolize is shipped with it's default data module which adds support for the following versions:
5673
| Minecraft Version | Supported |
5774
|--|--|
5875
| 1.8.x - 1.12.2 | ❌ (Only with [additional legacy module](https://ci.exceptionflug.de/job/Protocolize-Legacy-Data/)) |
59-
| 1.13 - 1.13.2 | ✔️ (Sounds only with [additional legacy module](https://ci.exceptionflug.de/job/Protocolize-Legacy-Data/)) |
76+
| 1.13 - 1.13.2 | ✔️ (Sounds only
77+
with [additional legacy module](https://ci.exceptionflug.de/job/Protocolize-Legacy-Data/)) |
6078
| 1.14 - 1.19.2 | ✔️ |
6179

6280
Implemented packets by default:
@@ -80,11 +98,13 @@ Implemented packets by default:
8098

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

83-
84101
## FAQ
102+
85103
You're experiencing uncommon packet errors and have ViaVersion/ViaBackwards installed on your proxy?
86-
This is likely caused by some bugs in those plugins. We recomment you to only install them on your sub-server when usign Protocolize.
104+
This is likely caused by some bugs in those plugins. We recomment you to only install them on your sub-server when usign
105+
Protocolize.
87106

88107
## Get some help
108+
89109
For documentation take a look at the wiki pages.
90110
If you have questions feel free to join our [discord server](https://discord.simplixsoft.com/).

0 commit comments

Comments
 (0)