Skip to content
/ MC-Server Public

Minecraft server management scripts

0 stars 0 forks Branches Tags Activity
Star
Notifications You must be signed in to change notification settings

Ven0m0/MC-Server

BranchesTags

Repository files navigation

🎮 Minecraft Server Management Suite

A professional, production-ready Minecraft server management toolkit with automated setup, comprehensive monitoring, backup solutions, and performance optimization.

License Fabric GraalVM

✨ Features

  • 🚀 Automated Server Management - One-command server setup and deployment
  • 📊 Real-time Monitoring - Health checks, performance metrics, and player activity tracking
  • 💾 Automated Backups - Scheduled backups with rotation and compression
  • 🔄 Auto-Restart & Crash Recovery - Watchdog service for maximum uptime
  • 📝 Log Management - Automatic log rotation, compression, and archiving
  • 🎯 Cross-Platform Support - Java + Bedrock Edition via Geyser
  • ⚡ Performance Optimized - GraalVM support with tuned JVM flags
  • 🔧 Mod Management - Profile-based mod organization and updates
  • 🌐 Public Hosting Ready - Playit.gg and Infrarust proxy support

📋 Table of Contents

🚀 Quick Start

Initial Setup

# 1. Clone the repository
git clone <your-repo-url>
cd MC-Server

# 2. Download and install Fabric server
./tools/mod-updates.sh install-fabric

# 3. Accept EULA and prepare server
./tools/prepare.sh

# 4. Start the server
./tools/server-start.sh

Quick Operations

# Monitor server health
./tools/monitor.sh status

# Create backup
./tools/backup.sh backup

# Start watchdog (auto-restart on crash)
./tools/watchdog.sh monitor

# Rotate logs
./tools/logrotate.sh maintenance

📦 Installation

System Requirements

  • OS: Linux (Ubuntu 20.04+, Debian 11+, or similar)
  • RAM: Minimum 4GB, Recommended 8GB+
  • Disk: 10GB+ free space
  • Java: Java 21+ (GraalVM recommended)

Required Dependencies

# Ubuntu/Debian
sudo apt update
sudo apt install -y openjdk-21-jdk curl wget unzip screen

# Optional: Install GraalVM for better performance
# Download from https://www.graalvm.org/downloads/

Optional Dependencies

# Fast parallel downloads
sudo apt install -y aria2

# JSON processing (choose one)
sudo apt install -y jq      # or
cargo install jaq

# Network utilities
sudo apt install -y netcat-openbsd

🎮 Server Scripts

Located in tools/ directory:

server-start.sh

Main server launcher with advanced optimizations

Features:

  • Auto-detection of CPU cores and RAM
  • GraalVM or Eclipse Temurin JDK support
  • Optimized G1GC garbage collection settings
  • Transparent Huge Pages support
  • GameMode integration for performance
  • Playit.gg tunnel support

Usage:

./tools/server-start.sh

# Use specific JDK
MC_JDK=graalvm ./tools/server-start.sh
MC_JDK=temurin ./tools/server-start.sh

mod-updates.sh

Fabric server installer and comprehensive mod management system

Features:

  • Fabric server installation with version selection
  • Ferium mod updates
  • mc-repack mod compression
  • GeyserConnect extension updates
  • Full workflow automation

Usage:

# Install Fabric server
./tools/mod-updates.sh install-fabric              # Latest stable
./tools/mod-updates.sh install-fabric 1.21.5       # Specific version
./tools/mod-updates.sh install-fabric 1.21.5 0.16.10  # With loader version

# Mod management
./tools/mod-updates.sh ferium                      # Update mods via Ferium
./tools/mod-updates.sh repack ./mods ./mods-repacked  # Repack mods
./tools/mod-updates.sh geyser                      # Update GeyserConnect

# Full workflow
./tools/mod-updates.sh full-update                 # Complete update cycle

mc-client.sh

Minecraft Java Edition client launcher

Usage:

./tools/mc-client.sh 1.21.5 YourUsername
MC_DIR=/custom/path ./tools/mc-client.sh 1.21.5 Player

prepare.sh

Initial server preparation (EULA acceptance, directory setup)

🛠️ Management Tools

Located in tools/ directory:

backup.sh - Backup Management

Automated backup solution for worlds, configurations, and mods.

Features:

  • Automated world backups with server notifications
  • Configuration and mod backups
  • Automatic backup rotation (keeps last N backups)
  • Restore functionality
  • Compression support

Usage:

# Full backup
./tools/backup.sh backup

# Backup specific components
./tools/backup.sh backup world
./tools/backup.sh backup config
./tools/backup.sh backup mods

# List backups
./tools/backup.sh list

# Restore backup
./tools/backup.sh restore minecraft/backups/worlds/world_20250119_120000.tar.gz

# Clean old backups
./tools/backup.sh cleanup --max-backups 10

Automated Backups:

# Add to crontab for daily backups at 4 AM
0 4 * * * cd /path/to/MC-Server && ./tools/backup.sh backup all

monitor.sh - Server Monitoring

Real-time server health monitoring and performance tracking.

Features:

  • Process and port status checking
  • Memory and CPU usage tracking
  • Disk space monitoring
  • Player activity tracking
  • Error detection and reporting
  • TPS monitoring (with Spark plugin)

Usage:

# Show status
./tools/monitor.sh status

# Continuous monitoring
./tools/monitor.sh watch

# Health check (for scripts)
./tools/monitor.sh alert

# View player activity
./tools/monitor.sh players

# Check errors
./tools/monitor.sh errors

watchdog.sh - Auto-Restart & Crash Recovery

Automatic server monitoring with crash recovery and restart capabilities.

Features:

  • Automatic restart on crashes
  • Configurable restart attempts and cooldowns
  • Emergency backup before restart
  • Graceful shutdown handling
  • Scheduled restarts with player warnings

Usage:

# Start watchdog monitor (run in screen/tmux)
./tools/watchdog.sh monitor

# Scheduled restart with 10-minute warning
./tools/watchdog.sh restart 600

# Immediate restart
./tools/watchdog.sh restart 0

# Start server
./tools/watchdog.sh start

# Stop server
./tools/watchdog.sh stop

# Check status
./tools/watchdog.sh status

Run as Background Service:

# Using screen
screen -dmS watchdog bash -c "cd /path/to/MC-Server && ./tools/watchdog.sh monitor"

# Using tmux
tmux new-session -d -s watchdog "cd /path/to/MC-Server && ./tools/watchdog.sh monitor"

logrotate.sh - Log Management

Automated log rotation, compression, and archiving.

Features:

  • Automatic log rotation based on size
  • Compression of old logs
  • Age-based cleanup
  • Archive size limiting
  • Log viewing and searching

Usage:

# Full maintenance
./tools/logrotate.sh maintenance

# Rotate logs
./tools/logrotate.sh rotate

# Compress old logs
./tools/logrotate.sh compress

# Clean logs older than 14 days
./tools/logrotate.sh clean 14

# Show statistics
./tools/logrotate.sh stats

# View log
./tools/logrotate.sh view latest.log 100

# Search logs
./tools/logrotate.sh search "error" latest.log

Automated Log Rotation:

# Add to crontab for weekly log maintenance
0 3 * * 0 cd /path/to/MC-Server && ./tools/logrotate.sh maintenance

systemd-service.sh - Systemd Service Management

Create and manage systemd services for Minecraft server and Infrarust proxy.

Features:

  • Automated systemd service creation
  • Infrarust proxy service support
  • Service lifecycle management (enable, start, stop, restart)
  • Log viewing via journalctl
  • Auto-start on boot support

Usage:

# Create Minecraft server service
./tools/systemd-service.sh create

# Create Infrarust proxy service (installs infrarust if needed)
./tools/systemd-service.sh create-infrarust /opt/infrarust minecraft

# Enable service (auto-start on boot)
./tools/systemd-service.sh enable

# Start service
./tools/systemd-service.sh start

# Stop service
./tools/systemd-service.sh stop

# Restart service
./tools/systemd-service.sh restart

# View status
./tools/systemd-service.sh status

# View logs
./tools/systemd-service.sh logs 100

# Follow logs in real-time
./tools/systemd-service.sh follow

⚙️ Configuration

Environment Variables

Server Launcher (server-start.sh):

  • MC_JDK - JDK selection: graalvm or temurin (default: auto-detect)
  • JAVA_GRAALVM - Path to GraalVM installation
  • JAVA_TEMURIN - Path to Temurin installation

Client Launcher (mc-client.sh):

  • MC_DIR - Minecraft directory (default: ~/.minecraft)

Mod Manager (mod-updates.sh):

  • XDG_CONFIG_HOME - Config directory (default: ~/.config)

Server Properties

Edit server.properties to configure:

  • Server port, IP binding
  • Max players, view distance
  • Game mode, difficulty
  • World generation settings

Plugin Configuration

All plugin configs are in minecraft/config/ directory:

  • ServerCore (minecraft/config/servercore/) - Performance optimization settings
  • Geyser (minecraft/config/Geyser-Fabric/) - Bedrock Edition support
  • Floodgate (minecraft/config/floodgate/) - Bedrock authentication
  • And more...

📚 Documentation

Detailed documentation available in docs/:

📁 Directory Structure

MC-Server/
├── tools/                      # All operational scripts
│   ├── server-start.sh         # Main server launcher with lazymc support
│   ├── mod-updates.sh          # Fabric installer & mod management
│   ├── mc-client.sh            # Client launcher
│   ├── prepare.sh              # Initial setup & lazymc installation
│   ├── backup.sh               # Backup automation
│   ├── monitor.sh              # Server monitoring
│   ├── watchdog.sh             # Auto-restart & crash recovery
│   ├── logrotate.sh            # Log management
│   ├── systemd-service.sh      # Systemd service management
│   ├── rcon.sh                 # RCON protocol handler
│   └── world-optimize.sh       # World optimization
│
├── minecraft/                  # Minecraft-specific data
│   ├── config/                 # Plugin/mod configurations
│   │   ├── servercore/         # ServerCore settings
│   │   ├── Geyser-Fabric/      # Geyser configuration
│   │   ├── floodgate/          # Floodgate settings
│   │   ├── versions.sh         # Mod version tracker
│   │   └── ...                 # Other plugin configs
│   ├── backups/                # Backup storage
│   │   ├── worlds/             # World backups
│   │   ├── configs/            # Config backups
│   │   └── btrfs-snapshots/    # Btrfs snapshots (if supported)
│   ├── server.properties       # Minecraft server config
│   └── packsquash.toml         # Resource pack optimization config
│
├── docs/                       # Documentation
│   ├── SETUP.md                # Setup guide
│   ├── TROUBLESHOOTING.md      # Troubleshooting guide
│   ├── Flags.txt               # JVM flags reference
│   ├── mods.txt                # Mod list
│   └── mods-links.txt          # Mod download links
│
├── lib/                        # Shared utilities
│   └── common.sh               # Common functions
│
├── .github/                    # GitHub configuration
│   ├── workflows/              # CI/CD pipelines
│   ├── ISSUE_TEMPLATE/         # Issue templates
│   └── instructions/           # AI assistant context
│       ├── claude.md           # Claude AI instructions
│       ├── gemini.md           # Gemini AI instructions
│       └── copilot.md          # Copilot instructions
│
├── .config/                    # Application configs
│   └── rustic/                 # Rustic backup config
│
└── README.md                   # This file

🔧 Maintenance Tasks

Daily

  • Monitor server status: ./tools/monitor.sh status
  • Check for errors: ./tools/monitor.sh errors

Weekly

  • Create backup: ./tools/backup.sh backup
  • Rotate logs: ./tools/logrotate.sh maintenance
  • Update mods: ./tools/mod-updates.sh upgrade

Monthly

  • Clean old backups: ./tools/backup.sh cleanup
  • Clean old logs: ./tools/logrotate.sh clean 30
  • Review server performance and adjust configs

🤝 Contributing

Contributions are welcome! Please read our contributing guidelines:

  1. Fork the repository
  2. Create a feature branch: git checkout -b feature/amazing-feature
  3. Commit your changes: git commit -m 'Add amazing feature'
  4. Push to the branch: git push origin feature/amazing-feature
  5. Open a Pull Request

📝 License

This project is licensed under the MIT License - see the LICENSE file for details.

🙏 Acknowledgments

🔗 Useful Resources

📞 Support

Note: This is a production-ready server management suite. Always test changes in a development environment before applying to production servers.

About

Minecraft server management scripts

Topics

bash minecraft scripts minecraft-server mc

Resources

Readme

Contributing

Contributing

Security policy

Security policy
Activity

Stars

0 stars

Watchers

0 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

No packages published

Contributors 7

Languages