Minecraft Server Linux-Like Command

Still usable, but not supported & bad code base

I will be making another mc server management tool soon, a better one, with better code base

In this repository you will find my application that will allow you to create and manage your Minecraft server with Linux-like commands. The CLI program is located in the app.py file. It uses the argparse library to let you handle the server's core, the server's directory, its worlds, plugins, and properties. You are also allowed to load your server from a configuration file in JSON format (an example file is provided in the repo).

TL;DR

git clone https://github.com/ISOnRM/minecraft_server.git
cd minecraft_server/
./install-requirements.sh
source .venv/bin/activate
python3 app.py config -f server_config.json

OR

git clone https://github.com/ISOnRM/minecraft_server.git && cd minecraft_server/ && ./install-requirements.sh && source .venv/bin/activate && python3 app.py config -f server_config.json

The commands above will start the server with the following configuration:

1.21.4 Minecraft Version
Paper Core (Build #224)
Allowed RAM 4GB (min) - 6GB (max)

Run the requirements installation script or install them manually

./install-requirements.sh
source .venv/bin/activate

Loading Server via Configuration

To load your server via config you'll need to choose the server's directory name, provide a download URL for a core (or enter the version and its Paper build while leaving the URL as an empty string), set your RAM constraints, and provide the Java path on your Linux machine.

When the JSON file is set, you'll need to enter the following command:

python3 app.py config --file config_name.json

The program will then install the core and start the server showing the preferences on start:

$ python3 app.py config --file server_config.json

==================================================
            STARTING THE SERVER...
            Server's directory: server_test
            Core: paper-1.21.4-222.jar
            Min RAM: 1
            Max RAM: 2
==================================================

Downloading mojang_1.21.4.jar

<SNIP>

[20:17:38 INFO]: Done (9.505s)! For help, type "help"
[20:17:38 INFO]: *************************************************************************************
[20:17:38 INFO]: This is the first time you're starting this server.
[20:17:38 INFO]: It's recommended you read our 'Getting Started' documentation for guidance.
[20:17:38 INFO]: View this and more helpful information here: https://docs.papermc.io/paper/next-steps
[20:17:38 INFO]: *************************************************************************************
>

To stop the server, simply press CTRL+C to trigger a KeyboardInterrupt or type stop in the server's console:

> # Here i pressed CTRL+C
[20:18:57 INFO]: Stopping server
[20:18:57 INFO]: Saving players
[20:18:57 INFO]: Saving worlds

<SNIP>

==================================================
                  CTRL + C
             STOPPING THE SERVER
==================================================

<SNIP>

[20:18:57 INFO]: All I/O tasks to complete
[20:18:57 INFO]: [MoonriseCommon] Awaiting termination of worker pool for up to 60s...
[20:18:57 INFO]: [MoonriseCommon] Awaiting termination of I/O pool for up to 60s...
$

Manual Mode

If you wish to manually set up your server or manage an already existing server, you will need to use manual mode.

Setting Up the Server

$ python3 app.py manual server_test/ core install-paper --version 1.21.4 --build 222
$ cd server_test/
$ ls -1
paper-1.21.4-222.jar
plugins
server.properties

Starting the Server

$ cd ..
$ python3 app.py manual server_test/ server --help

usage: app.py manual work_dir server [-h] {start,remove,icon} ...

options:
  -h, --help           show this help message and exit

Server Actions:
  {start,remove,icon}  Available actions: start, remove, icon
    start              Start the server with specified options
    remove             Remove the server installation
    icon               Change the server icon

$ python3 app.py manual server_test/ server start --help

usage: app.py manual work_dir server start [-h] [--ram MIN MAX]

options:
  -h, --help     show this help message and exit
  --ram MIN MAX  Minimum and maximum RAM (in GB) for the server

$ python3 app.py manual server_test/ server start --ram 2 4

==================================================
            STARTING THE SERVER...
            Server's directory: server_test
            Core: paper-1.21.4-222.jar
            Min RAM: 2
            Max RAM: 4
==================================================

Downloading mojang_1.21.4.jar

<SNIP>

[20:28:39 INFO]: Done (9.135s)! For help, type "help"
[20:28:39 INFO]: *************************************************************************************
[20:28:39 INFO]: This is the first time you're starting this server.
[20:28:39 INFO]: It's recommended you read our 'Getting Started' documentation for guidance.
[20:28:39 INFO]: View this and more helpful information here: https://docs.papermc.io/paper/next-steps
[20:28:39 INFO]: *************************************************************************************
>

The app.py will find the newest (by its name) core and start the server with the given RAM arguments. The default values for RAM are min = 4 GB and max = 6 GB.

Managing Worlds

To work with server worlds, use the following command to see available actions:

$ python3 app.py manual server_test/ world --help

usage: app.py manual work_dir world [-h] {pack,unpack,remove,list} ...

options:
  -h, --help            show this help message and exit

World Actions:
  {pack,unpack,remove,list}
                        Available actions: pack, unpack, remove, list
    pack                Pack the current world into an archive
    unpack              Unpack a world from an archive
    remove              Remove an existing world
    list                List all available world archives

Packing a World

$ python3 app.py manual server_test/ world list
$ python3 app.py manual server_test/ world pack --name World_one
$ ls server_test/ | grep tar
World_one.tar
$ python3 app.py manual server_test/ world list
World_one

The command above archives the current world into a tar archive with the given name.

Unpacking a World

$ python3 app.py manual server_test/ world list
World_one
$ python3 app.py manual server_test/ world unpack --name World_one
$ python3 app.py manual server_test/ world list
$ ls server_test/ | grep world
world
world_nether
world_the_end

Voilà, you have just unpacked your world.

Managing Plugins

To download plugins for your server, follow these steps. For example, to add two plugins—Chunky and SkinsRestorer—create a file with their download links:

$ touch plugins.txt
$ echo "https://cdn.modrinth.com/data/TsLS8Py5/versions/4DON6SzK/SkinsRestorer.jar" > plugins.txt
$ echo "https://cdn.modrinth.com/data/fALzjamp/versions/ytBhnGfO/Chunky-Bukkit-1.4.28.jar" >> plugins.txt
$ cat plugins.txt
https://cdn.modrinth.com/data/TsLS8Py5/versions/4DON6SzK/SkinsRestorer.jar
https://cdn.modrinth.com/data/fALzjamp/versions/ytBhnGfO/Chunky-Bukkit-1.4.28.jar

Bulk Downloading Plugins

$ python3 app.py manual server_test/ plugin --help

usage: app.py manual work_dir plugin [-h] {download,bulk,remove,toggle,list} ...

options:
  -h, --help            show this help message and exit

Plugin Actions:
  {download,bulk,remove,toggle,list}
                        Available actions: download, bulk, remove, toggle, list
    download            Download a plugin from a specified URL
    bulk                Download plugins in bulk from a file containing URLs
    remove              Remove a plugin by name
    toggle              Toggle the state of a plugin (enable or disable)
    list                List all installed plugins

$ python3 app.py manual server_test/ plugin bulk --file plugins.txt
/home/mark/Desktop/Python_Learning/new_minecraft_server/server_test/plugins/SkinsRestorer.jar
/home/mark/Desktop/Python_Learning/new_minecraft_server/server_test/plugins/Chunky-Bukkit-1_4_28.jar
$ python3 app.py manual server_test/ plugin list
Chunky-Bukkit-1_4_28
SkinsRestorer

Note: Dots in plugin filenames are replaced with underscores to prevent extension issues.

Toggling a Plugin

$ python3 app.py manual server_test/ plugin toggle --help

usage: app.py manual work_dir plugin toggle [-h] --name NAME [--disable]

options:
  -h, --help   show this help message and exit
  --name NAME  Name of the plugin to toggle
  --disable    If set, disable the plugin instead of enabling it

$ python3 app.py manual server_test/ plugin list
Chunky-Bukkit-1_4_28
SkinsRestorer
$ python3 app.py manual server_test/ plugin toggle --name SkinsRestorer --disable
$ python3 app.py manual server_test/ plugin list
Chunky-Bukkit-1_4_28
SkinsRestorer (disabled)
$ python3 app.py manual server_test/ plugin toggle --name SkinsRestorer
$ python3 app.py manual server_test/ plugin list
Chunky-Bukkit-1_4_28
SkinsRestorer

Editing Server Properties

To change the port or any property the server runs on, use the properties feature:

$ python3 app.py manual server_test/ properties --help

usage: app.py manual work_dir properties [-h] {change-port,change-any} ...

options:
  -h, --help            show this help message and exit

Properties Actions:
  {change-port,change-any}
                        Available actions: change-port, change-any
    change-port         Change the server port
    change-any          Change any property in the server configuration

To change the server port:

$ python3 app.py manual server_test/ properties change-port --help

usage: app.py manual work_dir properties change-port [-h] --port PORT

options:
  -h, --help   show this help message and exit
  --port PORT  New port number for the server

$ python3 app.py manual server_test/ properties change-port --port 7777
$ cat server_test/server.properties | grep server-port
server-port=7777

You can also change any property with the change-any feature.

Removing the Server

To delete your server completely:

$ python3 app.py manual server_test/ server remove
$ ls server_test/
ls: cannot access 'server_test/': No such file or directory

Upcoming Features

Default values in some commands (e.g., port defaults to 25565)
Packed world compression

Recently changed

Shortened arguments (e.g., -p instead of --port)
Removed unused descriptor
Updated repo directory
Added requirements.txt

First ever repo

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Repository files navigation

Minecraft Server Linux-Like Command

Still usable, but not supported & bad code base

I will be making another mc server management tool soon, a better one, with better code base

TL;DR

OR

Run the requirements installation script or install them manually

Loading Server via Configuration

Manual Mode

Setting Up the Server

Starting the Server

Managing Worlds

Packing a World

Unpacking a World

Managing Plugins

Bulk Downloading Plugins

Toggling a Plugin

Editing Server Properties

Removing the Server

Upcoming Features

Recently changed

About

Uh oh!

Releases

Packages

Uh oh!

Languages

Name		Name	Last commit message	Last commit date
Latest commit History 28 Commits
server_management		server_management
.gitignore		.gitignore
README.md		README.md
app.py		app.py
install-requirements.sh		install-requirements.sh
requirements.txt		requirements.txt
server_config.json		server_config.json

ISOnRM/minecraft_server

Folders and files

Latest commit

History

Repository files navigation

Minecraft Server Linux-Like Command

Still usable, but not supported & bad code base

I will be making another mc server management tool soon, a better one, with better code base

TL;DR

OR

Run the requirements installation script or install them manually

Loading Server via Configuration

Manual Mode

Setting Up the Server

Starting the Server

Managing Worlds

Packing a World

Unpacking a World

Managing Plugins

Bulk Downloading Plugins

Toggling a Plugin

Editing Server Properties

Removing the Server

Upcoming Features

Recently changed

About

Resources

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Uh oh!

Languages

Packages