Waterfall/README.md

Travertine
=========

Travertine is Waterfall with additional protocols. 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.

Travertine focuses on one main area:

* **Additional Client Version Support**: Travertine aims to support client versions older then what is supported in upstream. This includes 1.7 support. Additionally Travertine may release Snapshot and PRE Client support patches as time permits.

## Why fork Waterfall?

Travertine has a goal of adding additional protocol versions.

Travertine was forked because of the fact that Waterfall intends to only support protocol versions supported by upstream BungeeCord. 

Travertine will track upstream Waterfall and merge changes as needed.

## How to (Server Admins)

Download a copy of Travertine.jar from our homepage here: [Travertine](https://papermc.io/downloads#Travertine)

Travertine requires **Java 8** or above.

## How To (Compiling from source)

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

Clone this repo, run `./travertine b` from *bash*, get jar from `Travertine-Proxy/bootstrap/target`

## Join us

* Feel free to open a PR! We accept contributions.
* Join us on IRC (irc.spi.gt #paper, [webchat](http://irc.spi.gt/iris/?nick=&channels=paper)).
* Visit our forums (https://papermc.io/forums).

Special Thanks To
-----------------
![YourKit-Logo](https://yourkit.com/images/yklogo.png)

[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 Travertine an OSS license so that we can make our software the best it can be.
[CI-SKIP] Remove jenkins references (#148) 2021-01-06 15:21:41 +01:00			`Travertine`
Use new build system from Waterfall 2018-11-11 10:47:01 +01:00			`=========`
Initial project structure. More to come soon.. 2016-06-27 08:09:47 +02:00
			`Travertine is Waterfall with additional protocols. 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.`

			`Travertine focuses on one main area:`

			`* Additional Client Version Support: Travertine aims to support client versions older then what is supported in upstream. This includes 1.7 support. Additionally Travertine may release Snapshot and PRE Client support patches as time permits.`

			`## Why fork Waterfall?`

			`Travertine has a goal of adding additional protocol versions.`

			`Travertine was forked because of the fact that Waterfall intends to only support protocol versions supported by upstream BungeeCord.`

			`Travertine will track upstream Waterfall and merge changes as needed.`

[CI-SKIP] Update README 2018-02-01 17:57:15 +01:00			`## How to (Server Admins)`

[CI-SKIP] Remove jenkins references (#148) 2021-01-06 15:21:41 +01:00			`Download a copy of Travertine.jar from our homepage here: [Travertine](https://papermc.io/downloads#Travertine)`
[CI-SKIP] Update README 2018-02-01 17:57:15 +01:00
Use new build system from Waterfall 2018-11-11 10:47:01 +01:00			`Travertine requires Java 8 or above.`
[CI-SKIP] Update README 2018-02-01 17:57:15 +01:00
			`## How To (Compiling from source)`

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

Use new build system from Waterfall 2018-11-11 10:47:01 +01:00			Clone this repo, run `./travertine b` from bash, get jar from `Travertine-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.`
Use new build system from Waterfall 2018-11-11 10:47:01 +01:00			`* Join us on IRC (irc.spi.gt #paper, [webchat](http://irc.spi.gt/iris/?nick=&channels=paper)).`
			`* Visit our forums (https://papermc.io/forums).`
Initial project structure. More to come soon.. 2016-06-27 08:09:47 +02:00
			`Special Thanks To`
			`-----------------`
			`![YourKit-Logo](https://yourkit.com/images/yklogo.png)`

Use new build system from Waterfall 2018-11-11 10:47:01 +01:00			`[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 Travertine an OSS license so that we can make our software the best it can be.`