Compatibility
WaterfallMC will run on popular distros as long as the minimum requirements are met.
Server
For consistant uptime it is recomended you host a server in a data center. If you dont already have a server, you can rent a dedicated or vitual server from one of our sponsored providers, OVHCloud, Linode, Vultr.
Minimum Recommended Distros
Other Distros
Although not tested, any distro with tmux => 1.6 and JRE => 17 should also be compatible with WaterfallMC servers.Dependencies
Before installing, you must ensure you have all the dependencies required to run wmcserver.
These intructions also cover other RHEL derivatives such as AlmaLinux and Rocky Linux.
Ubuntu 64-bit
Ubuntu =< 20.04

sudo dpkg --add-architecture i386; sudo apt update; sudo apt install curl wget file tar bzip2 gzip unzip bsdmainutils python3 util-linux ca-certificates binutils bc jq tmux netcat openjdk-17-jre
Ubuntu => 20.10

sudo dpkg --add-architecture i386; sudo apt update; sudo apt install curl wget file tar bzip2 gzip unzip bsdmainutils python3 util-linux ca-certificates binutils bc jq tmux netcat openjdk-17-jre
Debian 64-bit
Debian =< 10

sudo dpkg --add-architecture i386; sudo apt update; sudo apt install curl wget file tar bzip2 gzip unzip bsdmainutils python3 util-linux ca-certificates binutils bc jq tmux netcat openjdk-17-jre
Debian => 11

sudo dpkg --add-architecture i386; sudo apt update; sudo apt install curl wget file tar bzip2 gzip unzip bsdmainutils python3 util-linux ca-certificates binutils bc jq tmux netcat openjdk-17-jre
EPEL is required to install some dependencies needed for using LinuxGSM on CentOS.
yum install epel-release
CentOS 64-bit

yum install curl wget tar bzip2 gzip unzip python3 binutils bc jq tmux java-11-openjdk
Gamedig
GameDig is a recommended additional module that allows LinuxGSM to gather more info from the game server such as current map and connected players to be displayed in details and in logs. It also replaces the default LinuxGSM query module in monitor. To install GameDig follow the steps in the LinuxGSM documentation.Install Dependencies Using LinuxGSM
It is possible for LinuxGSM to install dependencies either by having the wmcserver user account with sudo access or running the installer as root.user with sudo access
During the installation if the game server user has sudo permissions LinuxGSM will attempt to install any missing dependencies itself.root user
if wmcserver is already installed run./wmcserver install
as root and LinuxGSM will automatically install missing dependencies.
Install
From the command-line do the following. Ensuring you have also installed the required dependencies.
1. Create a user and login.adduser wmcserver
For security best practice, ensure you set a strong password. Random password:
su - wmcserver2. Download linuxgsm.sh.
wget -O linuxgsm.sh https://linuxgsm.sh && chmod +x linuxgsm.sh && bash linuxgsm.sh wmcserver3. Run the installer following the on-screen instructions.
./wmcserver install
Basic Usage
All Commands
A complete list of commands can be found by typing../wmcserverBelow are the most common commands available.
Running
start
./wmcserver start
stop
./wmcserver stop
restart
./wmcserver restart
console
Console allows you to view the live console of a server as it is running and allow you to enter commands; if supported../wmcserver console
To exit the console press CTRL+b d. Pressing CTRL+c will terminate the server.
Updating
update
Update checks for any server updates and applies them. The server will update and restart only if required../wmcserver update
Debugging
Details
You can get all important and useful details about the server such as passwords, ports, config files etc.
./wmcserver details
Debug
Use debug mode to help you if you are having issues with the server. Debug allows you to see the output of the server directly to your terminal allowing you to diagnose any problems the server might be having.
./wmcserver debug
Logs
Server logs are available to monitor and diagnose your server. Script, console and game server (if available) logs are created for the server.
/home/wmcserver/logs
Backup
Backup will allow you to create a complete tar bzip2 archive of the whole server.
./wmcserver backup
Monitor
LinuxGSM can monitor the game server by checking that the proccess is running and querying it. Should the server go offline LinuxGSM can restart the server and send you an alert. You can use cronjobs to setup monitoring.
./wmcserver monitor
Configure LinuxGSM
For details on how to alter LinuxGSM settings visit LinuxGSM Config Files page.
Documentation
For detailed documentation visit the LinuxGSM docs.
Cronjobs
To automate LinuxGSM you can set scheduled tasks using cronjobs, to run any command at any given time. You can edit the crontab using the following.
crontab -e
Below are the recommended cron tasks.
*/5 * * * * /home/wmcserver/wmcserver monitor > /dev/null 2>&1 */30 * * * * /home/wmcserver/wmcserver update > /dev/null 2>&1 0 0 * * 0 /home/wmcserver/wmcserver update-lgsm > /dev/null 2>&1
Configure LinuxGSM
For details on how to alter LinuxGSM settings visit LinuxGSM Config Files page.
Documentation
For detailed documentation visit the LinuxGSM docs.