Skip to content

Repository files navigation

Simple Minecraft Manager

Simple Minecraft Manager is a server manager for Minecraft. This is designed from the ground up to be as simple to set up as possible. This is built for people who have little experience running a server. You may want to use Crafty Controller (Simple) or Pterodactyl (More features) if you have more experience.

Features

  • Automatic server setup
  • Automatic velocity proxy configuration
  • Easy to use
  • Simple setup
  • Multiple server support
  • Easy server management

Requirements

The java minecraft server has high memory requirements. By default, 4 GB of ram is required for the proxy and papermc lobby, but increases with plugins/mods/quantity of servers. You must also agree to the Minecraft EULA

You need docker and docker-compose, learn how to install the Docker Engine and learn how to install the Docker Compose plugin, you may want to give your user the docker group, if not, you may need to run some of the below commands with sudo.

  • Create a directory called mcm (or whatever you want).
  • Create this file in the directory as docker-compose.yml:
services:
minecraftmanager:
image: ghcr.io/trwy7/minecraftmanager:1.1.0hostname: minecraftmanagerstop_signal: SIGINTstop_grace_period: 60s# Enough time for the servers to stopports:
- 7843:7843# HTTP
- 25565:25565# Minecraft Java
- 25565:25565/udp # Minecraft Java
- 19132:19132/udp # Minecraft Bedrock (via geysermc)volumes:
- servers:/servers
- data:/data
- backups:/backupsenvironment:
- SECRET_KEY=ChangeMeP13aseThisIsNotAGoodSecretKey
- BASE_DOMAIN=mc.example.com # Optional
- SERVER_OWNER=069a79f4-44e9-4726-a5be-fca90e38aaf5 # Optionalvolumes:
servers:
data:
backups:
  • Replace ChangeMeP13aseThisIsNotAGoodSecretKey with any random alphanumeric string larger than 32 characters.
  • Replace mc.example.com with the domain that players can join from, this assumes you have a wildcard of your domain (*.domain.tld) that is also pointed at this server, you may remove this line if you do not have a domain, can't setup a wildcard, or want to force players to go through the lobby server to join.
  • Replace 069a79f4-44e9-4726-a5be-fca90e38aaf5 with your own full Minecraft UUID, or remove it if you do not have a minecraft java account
    • To get your UUID, go to NameMC and search your Minecraft username
    • If you set this, you will automatically be given /op, /deop, and luckperms admin automatically on each server

After setting everything how you want, run docker-compose up -d (within the directory) When starting MCM for the first time, run docker compose logs | grep password (also within the directory) to find the admin account password

First run

The web UI is available at port 7843, try this link By default, a proxy (velocity) and a lobby (paper) server is created. These servers cannot be deleted, but new servers may be added very easily:

  • Click add server
  • Select a name, server software, and game version
  • Wait 1 minute
  • Click your server's name
  • Go to files
  • Add some plugins/mods
  • Start your server
  • Players may join with /server <name> while in game, or by joining <name>.<yourdomain>

This project is designed to be forked, and for the user to add their own configurations.

Included plugins

A few plugins are automatically installed, here are the most notable. You can delete them, but things may break.

  • Geyser + Floodgate
    • Allows bedrock players to join your server(s)
  • Luckperms
    • Automatically gives you the * permission on each server you create
  • Simple voice chat
    • Proximity chat for minecraft
    • To get this to work, you need to give players the voicechat.speak, voicechat.listen, and voicechat.groups permission to true. To do this, run:
      • /luckperms group default permission set voicechat.speak true
      • /luckperms group default permission set voicechat.listen true
      • /luckperms group default permission set voicechat.groups true
  • Velocitab (proxy only)
    • Customizes the tab list
  • Velocircon (proxy only)
    • RCON support for velocity
  • Viaversion + Viabackwards + Viarewind (paper only)
    • Allows players from different client versions to join your server
  • FabricProxy-Lite (fabric only)
    • Velocity forwarding support for fabric

About

No description, website, or topics provided.

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages