mirror of
https://github.com/PaperMC/Waterfall.git
synced 2024-12-01 06:33:39 +01:00
43 lines
2.2 KiB
Markdown
43 lines
2.2 KiB
Markdown
# Waterfall <a href="https://ci.getwaterfall.xyz/project.html?projectId=Waterfall"><img src="https://ci.getwaterfall.xyz/app/rest/builds/buildType:Waterfall_Build,branch:master/statusIcon"/></a>
|
|
|
|
Waterfall is a fork of the well-known [BungeeCord](https://github.com/SpigotMC/BungeeCord) server teleportation suite.
|
|
|
|
Waterfall focuses on three main areas:
|
|
|
|
* **Stability**: Waterfall aims to be stable. We will achieve this through making the code base testable and discouraging practices that lead to proxy lag.
|
|
* **Features**: Waterfall aims to include more features than canonical BungeeCord.
|
|
* **Scalability**: Waterfall should be able to handle a large number of concurrent players, given a reasonably modern CPU, memory, and good network connection.
|
|
|
|
## Why fork BungeeCord?
|
|
|
|
Think of Waterfall as a principles fork.
|
|
|
|
Waterfall was forked because of the fact that upstream does not accept many contributions that are intended to better the ecosystem. Simply put, Waterfall aims to better
|
|
the ecosystem by allowing changes to be exposed to a wider audience more quickly.
|
|
|
|
Waterfall will still track upstream BungeeCord and merge changes as needed.
|
|
|
|
How To (Server Admins)
|
|
------
|
|
Download a copy of Waterfall.jar from our buildserver here: [Waterfall](https://ci.aquifermc.org/job/Waterfall/)
|
|
|
|
Waterfall requires **Java 8** or above.
|
|
|
|
How To (Compiling From Source)
|
|
------
|
|
To compile Waterfall, you need JDK8, git, bash, maven, and an internet connection.
|
|
|
|
Clone this repo, run ./build.sh from *bash*, get jar from Waterfall-Proxy/bootstrap/target/
|
|
|
|
## Join us
|
|
|
|
* Feel free to open a PR! We accept contributions.
|
|
* Join us on IRC (irc.esper.net #waterfall, [webchat](http://webchat.esper.net/?nick=&channels=waterfall)).
|
|
* Visit our forums on [Aquifer](https://aquifermc.org).
|
|
|
|
Special Thanks To
|
|
-----------------
|
|
|
|
|
|
[YourKit](https://yourkit.com/), makers of the outstanding Java profiler, supports open source projects of all kinds with their full-featured [Java](https://yourkit.com/features/) and [.NET](https://yourkit.com/dotnet/features/) application profilers. We thank them for granting Waterfall an OSS license so that we can make our software the best it can be.
|