Faucet

A script written in Bash which allows you to easily manage a Waterfall server.

---

Table of Contents

• Table of Contents
• About The Project
• Features
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Recommended Usage
• Roadmap
• Contributing
• License
• Contact
• Acknowledgements

About The Project

Faucet is a script which allows you to easily manage a Waterfall Minecraft server.

I found myself manually navigating to the Waterfall website to check for and download new builds. Any repetitive task should be automated and thus Faucet was born.

Faucet can Backup, Trim, Update, and Start your Waterfall server.

This was made public in the hopes it's useful to others. Feel free to use this as a template and modify to suit your needs.

Features

• Install and update Waterfall
• Backup the entire server directory to a specified location
• Delete old backups (trim)
• Start the server in a loop (for crash recovery)

Getting Started

These steps assume you are running a Debian/Ubuntu based distribution of Linux, however, these steps should be similar for all Linux distributions. To get a local copy up and running follow these simple steps.

Prerequisites

Faucet does not have many dependencies. Java packages are different for many distributions, you may need to lookup the package name for flavor of Linux.

• jq
• Java
• curl

sudo apt install jq openjdk-11-jre curl

Installation

1. Clone the repo

git clone https://github.com/InvisaMage/Faucet.git

2. Edit the faucet.conf file to suit your needs
3. Make all the scripts executable

chmod +x *.sh

Usage

Simply run the main script and Faucet will take care of the rest.

./faucet.sh

Please note, on the first run, you will need to accept the Minecraft EULA manually.

The other scripts may be run as well, however, they are not well maintained. Use them at your own risk.

Recommended Usage

Faucet works best if it's ran using Crontab and screen

Here's an example of a crontab file:

@reboot cd /home/mc/server && /usr/bin/screen -d -m -h 500 ./faucet.sh

This will run Faucet every time the computer reboots and runs it under the screen terminal multiplexer.

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Travis - support@invisamage.com

Project Link: https://github.com/InvisaMage/faucet

Acknowledgements

• Various bash scripting resources
• My Linux Administration teacher
• Best README Template
• Terminalizer
• Text to ASCII Art Generator
• Logo is licensed under the CC BY 4.0