Minecraft Server¶

Key Features¶

• Multiplayer game - the server allows up to 255 players to connect and play simultaneously;
• Customizable game world - the administrator can create unique worlds, install plug-ins and make modifications;
• Access Rights Management - the ability to assign different rights to players in different parts of the world;
• Protection against griefer - tools to protect the world from player vandalism;
• Backup - automatic backup of the server world to prevent data loss;
• Multiple worlds - the option to run multiple different worlds on the same server;
• API - a set of interfaces for server interaction with other applications;
• Monitoring - online, activity and event log tracking;
• Performance - optimized to run on a dedicated server with a large number of players.

Features of the assembly¶

• Installation on Debian 11, 12; Ubuntu 20.04, 22.04 is possible;
• MCSMManager automatic installation is a Minecraft server cluster management service that allows you to:
  • Automatically start, stop and restart Minecraft servers;
  • Monitor server status and receive alerts;
  • Manage plugins, mods, configurations on servers;
  • Update server and plugin versions;
• Balance the load between servers in a cluster;
• Back up worlds and server data;
• Restore servers from backups;
• Scale the cluster by adding or removing servers.

System Requirements¶

Minecraft's resource requirements increase with the number of players on the server. Larger groups of players will require more RAM and disk space. Recommended System Requirements for a Minecraft Server:

• Processor (CPU): 2 cores or more, preferably 2GHz or higher;
• RAM: 2GB minimum for 1-2 players, 5GB for 3-6 players, 8GB for 6 or more players;
• Operating System: Minecraft is available for all major operating systems, but the operating system will require additional resources;
• Hard Drive space: 2GB minimum for 1-2 players, 18GB for 3-5 players, 35GB for 6+ players.

Starting after deploying a Minecraft Server¶

A notification will be sent to the e-mail specified during registration that the server is ready for work after paying for the order. It will contain the IP address of the VPS, as well as the login and password for the connection.

Clients of our company manage the hardware in the server`s and API control panel — Invapi.

Here is the data for authorization:

• Link to access: in the webpanel tag;
• Login and Password: comes in a letter to your email.

Initial settings¶

• After deploying the server, run the minecraft_easyset.sh script by typing its name at the command line.
• Enter TRUE in the script to accept the license agreement.
• The server service will automatically restart.
• Using the same script, enable the online-mode parameter, which is responsible for player authentication.

Game server management in MCSMManager¶

Once you have accessed the MCSMManager web interface, it is recommended that you create an administrator account. To do this, go to the Users section, click on _~New User~~ button and fill in the user information:

• Username;
• User Password;
• Permission:

Then click _~Add~~ button to create an account.

Add a new server¶

A one game server will be available for connection as soon as MCSMManager is deployed.

If you need to create an additional server, you can use several submenus - Applications and Quick Start. For example, in the Applications menu, simply click on the New Instance button:

And select one of the suggested creation options:

• Minecraft Server: Java Edition - To run the server, it is recommended that you use high performance server kernels in JAR format, such as Spigot or BungeeCord. They are optimized for high speed and compatibility with popular plugins.
• Minecraft Server: Bedrock Edition - for a dedicated Minecraft Bedrock server or other server kernel in binary format.
• General Game Server - for most game servers, running the appropriate server file will work. There may be compatibility issues with some games.
• General Console Application - just place the executable on the server and set it to start automatically. No installation is required.

After selecting one of the suggestions, a menu of installation options will open. For example, for Minecraft Server: Java Edition, there are three possible options:

• Upload single server core - Upload a single server core. For first time creation. You only need to upload one server core and the relative files will be created automatically on the first run.
• Upload server archive - Upload a server archive. For an existing server or a set of mods. The archive will be unpacked automatically. Only zip format is supported.
• Upload nothing or select existing file - Upload nothing or select existing file - the server does not require any files to run, or the required file(s) already exist on the remote machine. You only need to set the startup command and working directory manually.

Minecraft is already installed on the server, so you will need to select Upload nothing or select existing file and fill in the fields in the menu that opens:

• Choose your server from the existing file(s) - specifies the name of the server;
• Startup command - enter a startup command, e.g:

java -Dfile.encoding=UTF-8 -Duser.language=zh -Duser.country=CN -jar /home/minecraft/minecraft_server.jar nogui.

The command to execute can be found in the file /lib/systemd/system/minecraft-server.service.

• Server working directory - server working directory, e.g. /opt/mcsmanager/daemon/data/InstanceData/0bc1f9e46fc3467c8d90db6e16359954.

To start the Minecraft server, go to Application and click the ****Start** button:

If the server is configured correctly, the server will be started and the status will be changed to Running:

When starting the server, there may be a problem with the port used. To resolve this, you will need to edit the server.properties file. To do this, run the command

nano /home/minecraft/server.properties 

and change the port in the query.port and server-port lines:

Order a Minecraft server using the API¶

curl -s "https://invapi.hostkey.com/eq.php" -X POST \
--data "action=order_instance" \
--data "token=" \
--data "deploy_period=" \
--data "deploy_notify=" \
--data "email=" \
--data "pin=" \
--data "id=" \
--data "os_id=" \
--data "root_pass=" \
--data "hostname=" \
--data "ssh_key=" \
--data "post_install_callback=" \
--data "post_install_script=" \
--data "reinstall_key=" \
--data "os_name=" \
--data "imitate_deploy=" \
--data "imitate_error=0" \
--data "own_os=" \
--data "jenkins_task=" \
--data "traffic_plan=" \
--data "invoice_relid=" \
--data "preset=" \
--data "location_name=" \