Skip to main content

CLI tool to enhance and simplify containerization of Minecraft servers

Project description

MinecraftDockerCLI

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

: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

Currently resolving issues and developing the unit tests for future updates.

Already Planned releases

VERSION INCLUDES
1.0.0 First release (Do full tests)

Feel free to open Feature Requests issues to request things related to this concepts such popular IDE's, popular Git services with REST API's (API needed for being able to give support), unwanted types of files and folders generated by WorkSpace creations, etc.

: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-0.7.0.tar.gz (22.0 kB view details)

Uploaded Source

Built Distribution

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

minecraftdockercli-0.7.0-py3-none-any.whl (26.9 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for minecraftdockercli-0.7.0.tar.gz
Algorithm Hash digest
SHA256 0d6c695209c2480308300e7dd91e5b20a2013bbb222fc4123ef878956556f5d7
MD5 d6a7a9e1b09a985820af8a3c061b9edb
BLAKE2b-256 65c82017ac2c9c1c4e6b211211b6c9ff5ceb540708e0369a9d36010300b6b003

See more details on using hashes here.

Provenance

The following attestation bundles were made for minecraftdockercli-0.7.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-0.7.0-py3-none-any.whl.

File metadata

File hashes

Hashes for minecraftdockercli-0.7.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d5771c2d16e3fbb60fe2230f5b5f25978561ba5890d761c9b58be478714b7a24
MD5 727b5dae0aba103428774bf11786a637
BLAKE2b-256 d5f79f7662eff6c924637e9b0cafa2d01fd9a3e66c56ffe87d71882c3b7a5239

See more details on using hashes here.

Provenance

The following attestation bundles were made for minecraftdockercli-0.7.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