A server management CLI for self-hosting Minecraft Java Edition with AWS Elastic Container Service.

This project is a wrapper around the AWS SDK and vatertime/minecraft-spot-pricing, a CloudFormation template for managing resources for hosting itzg/docker-minecraft-server Docker image in AWS ECS.

Features

Useful commands for orchestrating containers with the AWS SDK
Supports vanilla and modded servers
vatertime/minecraft-spot-pricing claims an inexpensive $10/mo for a server running full-time. However, it's recommended to stop the server when not in use to save money. Spot pricing is set to 5¢.

Prerequisites

Sign up for AWS. Be sure to setup billing.
Setup the AWS CLI .
Node.js v20+, `.nvmrc` is included.

Commands

cip

Copies a server's ip address to the clipboard.
ip

Displays a server's ip address.
ls

Lists your servers.
new

Creates a new server. Wait 5 minutes for commands like ip or status.
params

Get/set server parameters.
start

Starts a server.
status

Displays a server's status.
stop

Stops a server.
help

Displays help.

Infrastructure

Resources are provisioned using your default AWS CLI profile, falling back to us-east-1 as a default region.

AWS Elastic Container Service is used to deploy the Minecraft image. EC2 instance(s) are spun up upon request and remain running until told to shutdown via the stop command (remove the server entirely with rm).

Contributors are not responsible for any AWS costs incurred from using this CLI. Use at your own discretion.

Each "server" is given its own networking stack and ECS cluster for simple clean up -- keeps it ez. By default, your AWS account will be limited to 5 VPCs. With the default VPC, and assuming zero other provisioned resources, that means you can have a maximum of 4 servers operating simulateously.

Contributing

Pull Requests

Pull requests are welcomed. Please leave detailed reasoning for your change. Bugs should include reproduction steps. OS can sometimes be helpful but this project lets commander.js manage cross-platform compatibility.

Development

License

MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.