JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 167
  • Score
    100M100P100Q81516F
  • License Apache-2.0

CLI tool for managing Docker Minecraft servers with mc-router

Package Exports

  • @minecraft-docker/mcctl
  • @minecraft-docker/mcctl/dist/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@minecraft-docker/mcctl) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

@minecraft-docker/mcctl

CLI tool for managing Docker Minecraft servers with mc-router.

Features

  • Multi-server management with hostname-based routing
  • Auto-scaling: Servers start on connect, stop when idle
  • Interactive mode: Guided prompts for all operations
  • World management: Assign and release worlds between servers
  • Backup system: GitHub-based world backup and restore

Installation

npm install -g @minecraft-docker/mcctl

Quick Start

# Initialize platform in ~/minecraft-servers
mcctl init

# Create a new server (interactive)
mcctl create

# Create with arguments
mcctl create myserver -t PAPER -v 1.21.1

# Check server status
mcctl status

# Start/stop servers
mcctl start myserver
mcctl stop myserver

# View logs
mcctl logs myserver

Commands

Command Description
mcctl init Initialize the platform
mcctl create [name] Create a new server
mcctl delete [name] Delete a server
mcctl status Show all server status
mcctl start <name> Start a server
mcctl stop <name> Stop a server
mcctl logs <name> View server logs
mcctl world list List all worlds
mcctl world assign Assign world to server
mcctl world release Release world from server
mcctl backup push Backup worlds to GitHub
mcctl backup restore Restore worlds from backup

Server Types

Type Description
PAPER Paper server (default, recommended)
VANILLA Official Minecraft server
FORGE Forge mod server
FABRIC Fabric mod server

Requirements

  • Node.js >= 18.0.0
  • Docker & Docker Compose
  • Linux or macOS

Documentation

License

Apache-2.0