Waterfall/README.md

41 lines
2.3 KiB
Markdown

FlameCord
=======
FlameCord is a patch for Waterfall to fix possible exploits and add useful functionalities. Waterfall is a fork of the well-known [BungeeCord](https://github.com/SpigotMC/BungeeCord) server teleportation suite.
FlameCord is compiled like Waterfall does; Please follow the [CONTRIBUTING.md](https://github.com/2lstudios-mc/FlameCord/blob/master/CONTRIBUTING.md) file. If you need help you can always contact us on Discord.
<a href="https://discord.gg/gF36AT3"><img src="https://discord.com/assets/4ff060e44afc171e9622fbe589c2c09e.png" width=10% height=10%><img/><a/> <a href="https://www.mc-market.org/resources/13492/"><img src="https://www.mc-market.org/styles/mcmarketv2/xenforo/logo.png" width=10% height=10%><img/><a/>
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.
FlameCord being a fork of Waterfall, has all its features, and some of its own, such as:
* **Exploit Fixes**: FlameCord specializes in providing better server security by fixing major exploits, performance flaws and bugs that Bungeecord already has, and that have not yet been fixed in WaterfallMC.
## Why fork Waterfall?
Waterfall was forked because of the fact that Waterfall intends to only support protocol versions supported by upstream BungeeCord.
FlameCord will track upstream Waterfall and merge changes as needed.
## How to (Server Admins)
You can support the development of FlameCord by purchasing it at [MC-Market](https://www.mc-market.org/resources/13492/). Or you can download it for free in the [releases tab](https://github.com/2lstudios-mc/FlameCord/releases).
FlameCord requires **Java 8** or above.
## How To (Compiling from source)
To compile FlameCord, you need JDK8, git, bash, maven, and an internet connection.
Clone this repo, run `./flamecord b` from *bash*, get jar from `FlameCord-Proxy/bootstrap/target`
## Join us
* Feel free to open a PR! We accept contributions.
* Join to our [Discord Server](https://discord.gg/gF36AT3).