Skip to main content

CLI tool to enhance and simplify containerization of Minecraft servers

Project description

Minecraft Docker CLI

Set up your Minecraft network blazingly fast

license stars downloads Visitors open issues

MinecraftDockerCLI is a python CLI application to allow minecraft server admins to set up in a fast and easy way a server or a network using docker containers. MinecraftDockerCLI is orientated towards minecraft server admins that administrate networks, since a single server cannot fully use the advantages of Docker containers. Docker containers make minecraft networks easier and cleaner because of how docker containers work and intercomunicate on the same machine.

:bookmark_tabs: Table of Contents

:blue_heart: Main Feautures

  • Full Minecraft servers Containerization
  • Prompt based data input
  • Up/Down, Start/Stop docker commands implementation
  • SQL database compatibility
  • Web servers compatibility
  • Backups for Minecraft Servers and Databases

:arrow_down: Installation

Prerequisites:

  • Docker Engine (Docker Desktop on Windows) running and configured.
  • Docker Compose (bundled with modern Docker Desktop installations).
  • Python 3.13+ and pip.

Recommended Installation:

# Create a Virtual Environment
python3 -m venv .venv
.\.venv\Scripts\Activate.ps1

# Install the python package
pip install MinecraftDockerCLI

Clone repo:

Extra requirement: Poetry.

# Clone the repository
git clone https://github.com/Dtar380/Minecraft-Dockerfile-CLI.git
cd Minecraft-Dockerfile-CLI

poetry install

[!NOTE] When running the program you would need to be using the poetry environment and run it like poetry run MinecraftDockerCLI

:wrench: Tips & Troubleshooting

  • Ensure Docker Desktop is running and you can run docker ps without errors before invoking the CLI.
  • On Windows, run PowerShell as Administrator or ensure your user has permissions for Docker.
  • If data.json is missing, run builder create first to scaffold services.

:memo: Working On

Project is finished!

Already Planned releases

VERSION INCLUDES

Feel free to open Feature Requests at issues.

:open_file_folder: Kown Issues

There is no known issues on the project, you can submit yours to issues.

:scroll: License

This project is distributed under the MIT license. See the LICENSE.

:money_with_wings: Sponsorship

You can support me and the project with a donation to my Ko-Fi.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

minecraftdockercli-1.0.0.tar.gz (22.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

minecraftdockercli-1.0.0-py3-none-any.whl (27.7 kB view details)

Uploaded Python 3

File details

Details for the file minecraftdockercli-1.0.0.tar.gz.

File metadata

  • Download URL: minecraftdockercli-1.0.0.tar.gz
  • Upload date:
  • Size: 22.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for minecraftdockercli-1.0.0.tar.gz
Algorithm Hash digest
SHA256 9bd6c620b57e3fe412fefda3c12a4b686b89db1bf8d4e86dddd545ff7c66a064
MD5 5b07b244bc37cfb945b9937c8c695407
BLAKE2b-256 ff038998b055b9542866445d1d2a919e85e9e773da3dbbefa3c0fe2b52654312

See more details on using hashes here.

Provenance

The following attestation bundles were made for minecraftdockercli-1.0.0.tar.gz:

Publisher: publisher.yml on Dtar380/MinecraftDockerCLI

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file minecraftdockercli-1.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for minecraftdockercli-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f968aa74c3029dda0cc10a7791179641ba94ad10716d21bf49445905d2f7d1b7
MD5 860d5622c1eb56ec091ba8df8fb95a69
BLAKE2b-256 9bff803a9077617097647233eb2488cfd75cdeed3845677cb4fa0877b54450af

See more details on using hashes here.

Provenance

The following attestation bundles were made for minecraftdockercli-1.0.0-py3-none-any.whl:

Publisher: publisher.yml on Dtar380/MinecraftDockerCLI

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page