Upstream/Waterfall
1
0
Fork 0
mirror of https://github.com/PaperMC/Waterfall.git synced 2024-11-15 23:06:01 +01:00
Code Issues Projects Releases Wiki Activity
b3296adf72
Waterfall/README.md

44 lines
2.1 KiB
Markdown
Raw Normal View History

Update jenkins and urls to point towards papermc
2019-01-13 23:17:54 +01:00
Waterfall [![Build Status](https://papermc.io/ci/job/Waterfall/badge/icon)](https://papermc.io/ci/job/Waterfall/)
Update README to use the temporary CI
2016-12-09 19:51:02 +01:00
=========
Turn waterfall into a patch-based fork like Spigot and Paper (WIP) Allows us to easily see and manage the diff with upstream. Makes fixing conflicts with upstream easier and shows a cleaner, more acurate commit history. All credits to scripts go to @md_5 @aikar @Zbob750 @Thinkofname @Byteflux @Techcable (GPL3 Licensed)
2016-05-28 18:34:39 +02:00
Waterfall is a fork of the well-known [BungeeCord](https://github.com/SpigotMC/BungeeCord) server teleportation suite.
Waterfall focuses on three main areas:
Update README to use the temporary CI
2016-12-09 19:51:02 +01:00
- **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.
Turn waterfall into a patch-based fork like Spigot and Paper (WIP) Allows us to easily see and manage the diff with upstream. Makes fixing conflicts with upstream easier and shows a cleaner, more acurate commit history. All credits to scripts go to @md_5 @aikar @Zbob750 @Thinkofname @Byteflux @Techcable (GPL3 Licensed)
2016-05-28 18:34:39 +02:00
## Why fork BungeeCord?
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 better
the ecosystem by allowing changes to be exposed to a wider audience more quickly.
Waterfall will still track upstream BungeeCord and merge changes as needed.
Update README to use the temporary CI
2016-12-09 19:51:02 +01:00
## How To (Server Admins)
Merge upstream; remove fire-pit
2018-09-30 20:17:21 +02:00
Download a copy of Waterfall.jar from our buildserver here: [Waterfall](https://papermc.io/ci/job/Waterfall/)
Add build script and update README.md
2016-06-30 00:42:20 +02:00
Waterfall requires **Java 8** or above.
Update README to use the temporary CI
2016-12-09 19:51:02 +01:00
## How To (Compiling From Source)
Add build script and update README.md
2016-06-30 00:42:20 +02:00
To compile Waterfall, you need JDK8, git, bash, maven, and an internet connection.
Add waterfall command
2016-11-26 22:33:41 +01:00
Clone this repo, run `./waterfall b` from *bash*, get jar from Waterfall-Proxy/bootstrap/target/
Add build script and update README.md
2016-06-30 00:42:20 +02:00
Turn waterfall into a patch-based fork like Spigot and Paper (WIP) Allows us to easily see and manage the diff with upstream. Makes fixing conflicts with upstream easier and shows a cleaner, more acurate commit history. All credits to scripts go to @md_5 @aikar @Zbob750 @Thinkofname @Byteflux @Techcable (GPL3 Licensed)
2016-05-28 18:34:39 +02:00
## Join us
* Feel free to open a PR! We accept contributions.
readme fixes
2018-10-29 06:48:18 +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).
Turn waterfall into a patch-based fork like Spigot and Paper (WIP) Allows us to easily see and manage the diff with upstream. Makes fixing conflicts with upstream easier and shows a cleaner, more acurate commit history. All credits to scripts go to @md_5 @aikar @Zbob750 @Thinkofname @Byteflux @Techcable (GPL3 Licensed)
2016-05-28 18:34:39 +02:00
Update README to use the temporary CI
2016-12-09 19:51:02 +01:00
## Special Thanks To
Turn waterfall into a patch-based fork like Spigot and Paper (WIP) Allows us to easily see and manage the diff with upstream. Makes fixing conflicts with upstream easier and shows a cleaner, more acurate commit history. All credits to scripts go to @md_5 @aikar @Zbob750 @Thinkofname @Byteflux @Techcable (GPL3 Licensed)
2016-05-28 18:34:39 +02:00
![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 Waterfall an OSS license so that we can make our software the best it can be.
Reference in New Issue Copy Permalink