mirror of
https://github.com/WaterdogPE/WaterdogPE
synced 2024-09-22 06:10:51 +00:00
57 lines
2.4 KiB
Markdown
57 lines
2.4 KiB
Markdown
# WaterdogPE
|
|
[](https://jenkins.waterdog.dev/job/Waterdog/job/WaterdogPE/job/master/)
|
|
[](https://discord.gg/QcRRzXX)
|
|
|
|
WaterdogPE is a brand new Minecraft: Bedrock Edition proxy software developed by the developers of the old Waterdog
|
|
Proxy.
|
|
In this new proxy, we are working with Cloudbursts Protocol Library. It takes alot of maintaining effort from us and
|
|
provides us with a nice api to work with.
|
|
If you want to discuss things without joining the discord server, please use the [Discussions Tab](https://github.com/WaterdogPE/WaterdogPE/discussions)
|
|
|
|
## Links
|
|
|
|
- [Website](https://waterdog.dev)
|
|
- [Discord](https://discord.gg/sJ452xNugw)
|
|
- [Official documentation](https://docs.waterdog.dev)
|
|
- [Issue Tracker](https://github.com/WaterdogPE/WaterdogPE/issues)
|
|
- [Public Plugins Page](https://plugins.waterdog.dev/)
|
|
- [Branding: various brand assets for the WaterdogPE project](https://github.com/WaterdogPE/Branding)
|
|
|
|
## Setup Guide
|
|
If you haven't used WaterdogPE before, we recommend you to take a look at our [setup guide](https://docs.waterdog.dev/books/waterdogpe-setup) in the docs.
|
|
*Please note that the config from the old Waterdog (Bungee) is not compatible with WaterdogPE*
|
|
|
|
### Supported Software
|
|
Our goal is to support all commonly used Minecraft: Bedrock server softwares. Spoons and unofficial forks will not be supported due to the lack
|
|
of proper implementation.
|
|
You can find list of currently supported/unsupported software [here](https://docs.waterdog.dev/books/waterdogpe-setup/page/software-compatibility).
|
|
|
|
## Compiling
|
|
|
|
To compile WaterdogPE please visit our [COMPILING.md](COMPILING.md) guide.
|
|
|
|
## Maven usage
|
|
|
|
```xml
|
|
<repositories>
|
|
<repository>
|
|
<id>waterdog-repo</id>
|
|
<url>https://repo.waterdog.dev/main</url>
|
|
</repository>
|
|
</repositories>
|
|
|
|
<dependencies>
|
|
<dependency>
|
|
<groupId>dev.waterdog.waterdogpe</groupId>
|
|
<artifactId>waterdog</artifactId>
|
|
<version>2.0.0-SNAPSHOT</version>
|
|
<scope>provided</scope>
|
|
</dependency>
|
|
</dependencies>
|
|
```
|
|
|
|
## Included libraries
|
|
|
|
- [Yamler: a forked yaml parsing library](https://github.com/WaterdogPE/Yamler)
|
|
- [Protocol: A fork of Nukkits Protocol library with various changes for the WaterdogPE project](https://github.com/WaterdogPE/Protocol)
|