Sueta

MCPanel

v2.4.1

A simple Minecraft server administration utility.

·Plugin

MCPanel: Minecraft server administration script

This script was written in order to help me manage my Minecraft server. I ran into several problems, which are fixed in this script.

It's currently available only on Linux, tested on Ubuntu 16.04 LTS.

Notable features:

  • - written in shell script: it will execute quick, depending on tasks. next versions will focus on performance improvements and quicker response
  • - completely modular: using pseudo-namespace function naming, I managed to auto-load a subshell (called module) dynamically
  • - easy to use: you only type "mcpanel [module] [command]" and it executes the script
  • - easy to configure: you can enable and disable modules, and alter configuration easily
  • - easy to extend: writing a module is simple.

Out-of-the-box modules:

  • build - this module was written to automatically download latest BuildTools and compile the server. You can configure to use either craftbukkit or spigot executables. It will copy automatically the executable in MCPANEL_DIRECTORY/process/server .
  • server - this module manages the server. you can start the server, view logs, or edit the configuration. Server's IP is set automatically, and it's checked always before the server starts. You can set three levels of visibility:
    1. local -> this one is used to set the host's local IP address. It won't change, as it's determined by hostname utility.
    2. lan -> this one is tricky. It sets your computer's IP address within a network, using a given network interface. This IP can vary, depending on router's IP allocation.
    3. public -> this one gives a performance loss. It checks on an external server resolver to return your public IP address, determined by dig utility.

Installation:

  1. you first need to have following packages installed: figlet, java, bash
    1. optionally: you can install midnight commander for exploring the server files outside desktop environment!
  2. download the latest release: https://github.com/hktr92/mcpanel/releases
  3. extract the file contents. for simplicity's sake, I'll refer to working directory as /srv/minecraft
  4. update your PATH environment: export PATH=/srv/minecraft/bin:$PATH
  5. set the executable flag for mcpanel: chmod +x /srv/minecraft/bin/mcpanel

Now that you have the panel installed, you can do various additional tasks:

  • manage modules: you can always enable or disable what modules you want, using mcpanel enable-module [module_name] or mcpanel disable-module [module_name]
  • fine tuning over your server: you can change some settings in [MCPANEL_DIRECTORY]/core/mcpanel/mcpanel.cnf file

If you want to setup quickly a Minecraft server, using Spigot API, execute these commands:

  • mcpanel enable-module build
  • mcpanel build new
  • mcpanel enable-module server
  • mcpanel server start

Explanation:

  • first line: will enable build module
  • second line: will generate a new build of launcher (downloads BuildTools if non-existent)
  • third line: enables server module in order to manage server tasks
  • fourth line: starts the server

Support and issues: I'm sorry, but I must request all be redirected to Github.

Similar projects

Plugin →