Skip to content

README.md

Latest commit

 

History

History
61 lines (39 loc) · 1.59 KB

README.md

File metadata and controls

61 lines (39 loc) · 1.59 KB
Raw
Favicon

MiniMC

Your lightweight Minecraft server companion!

What is MiniMC?

MiniMC is a simple, self-contained Minecraft server manager with a built-in web interface.

  • Start your server by typing start in the terminal.
  • Stop it with stop.
  • If it crashes, use kill.
  • Get the stats via stats
  • Includes a web-based file manager, accessible via /files in the terminal.

Features

  • Automatically downloads and runs the latest PaperMC server build.
  • Single-container setup designed with Docker in mind.
  • Lightweight, but includes advanced logging in the web interface.
  • Self-contained: all server files are stored locally in /minecraft.

Getting Started

  1. Clone the repository:
git clone https://github.com/bijsven/MiniMC.git
cd MiniMC
  1. Configure Docker Compose to your needs. By default:
  • Minecraft server exposed on 25565
  • Web interface exposed on 8080
  • Server files stored in /minecraft locally and internally within the container
  1. Start MiniMC:
docker-compose up
  1. Access the web interface via http://localhost:8080 and manage your server easily.
  2. Enjoy!

Usage Notes

  • MiniMC auto-updates the PaperMC server jar whenever restarted.
  • Use the terminal commands (start, stop, kill, stats) to control the server.
  • All server data is persistent inside the /minecraft folder, so you can safely restart or update the container. (as long as you use the original docker compose file)

License

MIT License – see LICENSE