Skip to content

Latest commit

 

History

History
92 lines (71 loc) · 4.12 KB

README.md

File metadata and controls

92 lines (71 loc) · 4.12 KB

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.

📑 Table of Contents

💙 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

⬇️ 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

🔧 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.

📝 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 at issues.

📂 Kown Issues

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

📜 License

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

💸 Sponsorship

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