Repository files navigation

Waterfall is a fork of the well-knownBungeeCord 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.

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 betterthe ecosystem by allowing changes to be exposed to a wider audience more quickly.

Waterfall will still track upstream BungeeCord and merge changes as needed.

Download a copy of Waterfall.jar from our homepage here:Waterfall

Waterfall requiresJava 8 or above.

• See our API patcheshere
• Waterfall API JavaDocs here:papermc.io/javadocs
• Maven repository (forwaterfall-api):

<repository>    <id>papermc</id>    <url>https://repo.papermc.io/repository/maven-public/</url></repository>

• Artifact information:

<dependency>    <groupId>io.github.waterfallmc</groupId>    <artifactId>waterfall-api</artifactId>    <version>1.20-R0.3-SNAPSHOT</version>    <scope>provided</scope></dependency>

Or alternatively, with Gradle:

• Repository:

repositories {    maven {        url'https://repo.papermc.io/repository/maven-public/'    }}

• Artifact:

dependencies {    compileOnly'io.github.waterfallmc:waterfall-api:1.20-R0.3-SNAPSHOT'}

To compile Waterfall, you need JDK8, git, bash, maven, and an internet connection.

Clone this repo, run./waterfall b frombash, get jar from Waterfall-Proxy/bootstrap/target/

• Feel free to open a PR! We accept contributions.
• Join us onDiscord.
• Visit our forums (https://forums.papermc.io/).

YourKit, makers of the outstanding Java profiler, supports open source projects of all kinds with their full-featuredJava and.NET application profilers. We thank them for granting Waterfall an OSS license so that we can make our software the best it can be.