Waterfall/README.md
Juan Cruz Linsalata a20d83bc09
Update README.md
2022-11-11 17:56:29 +01:00

42 lines
2.0 KiB
Markdown

# FlameCord
FlameCord is a Waterfall fork or modification that adds antibot features, exploit prevention systems, performance improvements, removal of unused features, library updates and application layer ddos mitigation.
## Links
<a href="https://builtbybit.com/resources/13492/"><img src="https://archive.org/download/download-button-png/download-button-png.png" width=25% height=25%><img/><a/> <a href="https://discord.gg/gF36AT3"><img src="https://i.imgur.com/NyGBnuJ.png" width=25% height=25%><img/><a/>
## Features
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.
* **Antibot Features**: FlameCord brings swift bot protection for your Minecraft server to avoid extra CPU usage and crashes in your machines.
* **Performance Improvements**: FlameCord tries to improve performance by removing unused features and disabling exception logs.
## Why fork Waterfall?
FlameCord was forked out of a desire for greater protection to be afforded to a Bungeecord-based proxy, which Waterfall currently cannot offer.
FlameCord will track upstream Waterfall and merge changes as needed.
## How to (Server Admins)
Just drag an drop FlameCord.jar into your server folder and run it.
You can customize many FlameCord features in the flamecord.yml file.
## How To (Compiling from source)
To compile FlameCord, you need JDK8 or above, git, bash, maven, and an internet connection.
Clone this repo, run `./flamecord b` from *bash*, get jar from `FlameCord-Proxy/bootstrap/target`
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.
## Contribute
* Feel free to open a PR! We accept contributions.