minectl

New - 1.21.11 support

minectl 🗺️️ supports the Minecraft 1.21.11 version

minectl 🗺

minectl 🗺️️ is a CLI for creating Minecraft servers on different cloud providers.

It is a private side project of me, to learn more about Go, CLI and multi-cloud environments.

Table of Contents

• Supported Cloud Providers
• Quick Start
• Documentation
• Getting Started Guides
• Known Limitations
• Contributing
• Roadmap
• Libraries & Tools
• Legal Disclaimer

Supported Cloud Providers

Provider	Website
Civo	https://www.civo.com/
Scaleway	https://www.scaleway.com
DigitalOcean	https://www.digitalocean.com/
Hetzner	https://www.hetzner.com/
Akamai Connected Cloud	https://www.linode.com/
OVHCloud	https://www.ovh.com/
Google Compute Engine (GCE)	https://cloud.google.com/compute
Vultr	https://www.vultr.com/
Azure	https://azure.microsoft.com/en-us/
Oracle Cloud Infrastructure	https://www.oracle.com/cloud/
Amazon AWS	https://aws.amazon.com/
VEXXHOST	https://vexxhost.com/
Multipass	https://multipass.run/
Exoscale	https://www.exoscale.com/
Fuga Cloud	https://fuga.cloud/

Quick Start

Installation

Linux/macOS (Installation Script)

curl -sLS https://get.minectl.dev | sudo sh

or without sudo:

curl -sLS https://get.minectl.dev | sh

macOS (Homebrew)

brew tap dirien/homebrew-dirien
brew install minectl

Windows (PowerShell)

# Create directory
New-Item -Path "$HOME/minectl/cli" -Type Directory
# Download file
Start-BitsTransfer -Source https://github.com/dirien/minectl/releases/download/v0.7.0/minectl_0.7.0_windows_amd64.zip -Destination "$HOME/minectl/cli/."
# Uncompress zip file
Expand-Archive $HOME/minectl/cli/*.zip -DestinationPath $HOME/minectl/cli/.
# Add to Windows Environment Variables
[Environment]::SetEnvironmentVariable("Path",$($env:Path + ";$Home\minectl\cli"),'User')

From Source

git clone https://github.com/dirien/minectl
cd minectl
make build

Create Your First Server

1. Set up authentication for your cloud provider (see docs)

2. Create a config file using the wizard:

   minectl wizard
   

3. Create the server:

   minectl create --filename server.yaml
   

4. Connect and play!

Documentation

Document	Description
Architecture	High-level architectural overview
Authentication	Cloud provider credentials setup
Configuration	Server and proxy configuration reference
CLI Reference	All commands and flags
Editions	Supported Minecraft server and proxy editions
Features	Monitoring, volumes, security, and more

Getting Started Guides

• Civo Java Edition
• Civo Bedrock Edition
• Scaleway Java Edition
• GCE Edition
• Exoscale Edition
• Multi-cloud server monitoring
• LuckyBlocks on Scaleway
• PaperMC SkyBlock on Hetzner

Known Limitations

minectl 🗺 is still under development. There will be the possibility for breaking changes.

Contributing

Feel free to join! See our contribution guidelines.

License: Apache License, Version 2.0

Roadmap

• Support Bedrock edition #10
• Add monitoring capabilities #21
• List Minecraft Server #11
• Update Minecraft Server #12
• Hetzner support #26
• Linode support #31
• OVHCloud support #43
• GCE support #55
• Modded editions #20
• Vultr support #90
• Proxy servers (BungeeCord/Waterfall) #95
• Azure support #56
• Oracle/OCI support #107
• AWS support #210
• Much more to come…

Libraries & Tools

Click to expand

• https://github.com/charmbracelet/bubbletea
• https://github.com/charmbracelet/lipgloss
• https://github.com/charmbracelet/huh
• https://github.com/charmbracelet/bubbles
• https://github.com/melbahja/goph
• https://github.com/spf13/cobra
• https://github.com/goreleaser
• https://github.com/civo/civogo
• https://github.com/digitalocean/godo
• https://github.com/scaleway/scaleway-sdk-go
• https://github.com/linode/linodego
• https://github.com/hetznercloud/hcloud-go
• https://github.com/sethvargo/go-password
• https://github.com/ovh/go-ovh
• https://github.com/dirien/ovh-go-sdk
• https://github.com/hashicorp/go-retryablehttp
• https://github.com/googleapis/google-api-go-client
• https://github.com/Masterminds/sprig
• https://github.com/Tnze/go-mc
• https://github.com/c-bata/go-prompt
• https://github.com/vultr/govultr
• https://github.com/Azure/azure-sdk-for-go
• https://github.com/blang/semver
• https://github.com/tcnksm/go-latest
• https://github.com/uber-go/zap
• https://github.com/oracle/oci-go-sdk
• https://github.com/aws/aws-sdk-go-v2
• https://github.com/gophercloud/gophercloud
• https://github.com/exoscale/egoscale

Legal Disclaimer

This project is not affiliated with Mojang Studios, XBox Game Studios, Double Eleven or the Minecraft brand.

“Minecraft” is a trademark of Mojang Synergies AB.

Other trademarks referenced herein are property of their respective owners.

Stargazers over time