MCServer

About

A CLI tool to manage Minecraft: Java Edition servers.

Platform

Supported platforms:

• Linux
• and Termux.

Requirements

• Python 3.12 or newer (Python 3.14 is recommended)
• JRE (depends on Minecraft version)

How to install

• Using pip:

1. Run pip install mcserver-cli

• System-wide (Requires root):

1. Download the mcserver script file from GitHub releases
2. Move the file to /usr/local/bin
3. Run chmod +x mcserver

• Per-user:

1. Create a directory "bin"
2. Download the script from GitHub releases onto that directory
3. Give it "executable" permission with chmod +x mcserver
4. Add the directory in the PATH environment:
   • Run export PATH=$HOME/bin:$PATH if you're using shell that is POSIX-compliant like Bash, Zsh, or ash
   • Run fish_add_path ~/bin if you're using FISH

Usage

• Initialize a server: mcserver init [options]
• List operator players: mcserver op list
• Show information about projects: mcserver show <projects>
• Start the server: mcserver start
• Stop the server: mcserver stop [--force-stop]
• List whitelisted players: mcserver whitelist list

Example

• Create and start a Fabric 1.20.1 server on current directory

mcserver init --game-version=1.20.1 --loader=fabric
mcserver start

• List all operator and whitelisted players on current directory

mcserver op list
mcserver whitelist list

• Stop (sigterm) a server on current directory

mcserver stop

Note

This is a Personal Project, things may be unstable.