Waterfall/README.md

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/>

## Features

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 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)

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 or above, 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).
Update README.md 2020-08-18 23:05:30 +02:00			`FlameCord`
Updated Upstream (Travertine) 2021-02-24 03:48:58 +01:00			`=======`
Update README.md 2020-08-18 23:05:30 +02:00
Updated markdown files to reflect recent changes 2021-06-09 23:11:12 +02:00			`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.`
Update README.md 2020-08-18 23:05:30 +02:00
Updated markdown files to reflect recent changes 2021-06-09 23:11:12 +02:00			`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.`
Added comment in README with compilation step 2021-05-20 04:26:05 +02:00
Update README.md 2020-08-18 23:05:30 +02:00			`<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/>`

Small readme improvement 2021-06-09 23:23:45 +02:00			`## Features`

Initial project structure. More to come soon.. 2016-06-27 08:09:47 +02:00			`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.`

Updated markdown files to reflect recent changes 2021-06-09 23:11:12 +02:00			`FlameCord being a fork of Waterfall, has all its features, and some of its own, such as:`
Initial project structure. More to come soon.. 2016-06-27 08:09:47 +02:00
Updated markdown files to reflect recent changes 2021-06-09 23:11:12 +02:00			`* 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.`
Initial project structure. More to come soon.. 2016-06-27 08:09:47 +02:00
			`## Why fork Waterfall?`

Small readme improvement 2021-06-09 23:23:45 +02:00			`Waterfall was forked out of a desire for greater protection to be afforded to a Bungeecord-based proxy, which Waterfall currently cannot offer.`
Initial project structure. More to come soon.. 2016-06-27 08:09:47 +02:00
rename Travertine -> FlameCord 2021-06-09 00:23:21 +02:00			`FlameCord will track upstream Waterfall and merge changes as needed.`
Initial project structure. More to come soon.. 2016-06-27 08:09:47 +02:00
[CI-SKIP] Update README 2018-02-01 17:57:15 +01:00			`## How to (Server Admins)`

Updated markdown files to reflect recent changes 2021-06-09 23:11:12 +02:00			`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).`
[CI-SKIP] Update README 2018-02-01 17:57:15 +01:00
rename Travertine -> FlameCord 2021-06-09 00:23:21 +02:00			`FlameCord requires Java 8 or above.`
[CI-SKIP] Update README 2018-02-01 17:57:15 +01:00
			`## How To (Compiling from source)`

Small readme improvement 2021-06-09 23:23:45 +02:00			`To compile FlameCord, you need JDK8 or above, git, bash, maven, and an internet connection.`
[CI-SKIP] Update README 2018-02-01 17:57:15 +01:00
rename Travertine -> FlameCord 2021-06-09 00:23:21 +02:00			Clone this repo, run `./flamecord b` from bash, get jar from `FlameCord-Proxy/bootstrap/target`
[CI-SKIP] Update README 2018-02-01 17:57:15 +01:00
Initial project structure. More to come soon.. 2016-06-27 08:09:47 +02:00			`## Join us`

			`* Feel free to open a PR! We accept contributions.`
Updated markdown files to reflect recent changes 2021-06-09 23:11:12 +02:00			`* Join to our [Discord Server](https://discord.gg/gF36AT3).`