From f3f78101cf3f183150c4c202a6a7322abdee4716 Mon Sep 17 00:00:00 2001 From: Yuzu Date: Thu, 2 Jan 2025 23:19:36 +0700 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9A=20docs:=20Update=20README.md?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 46 ++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 44 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 881b7ad..e025c8a 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,44 @@ -# Minikura -Minikura ミニクラ- Manage Minecraft servers effortlessly in k8s +# ⛏️ Minikura ミニクラ +**Manage Minecraft servers effortlessly for Kubernetes** + +Minikura is designed to simplify the management and deployment of Minecraft servers within Kubernetes clusters. From SMP server to network of minigames, or mix of those. + +🚧 **Note:** Minikura is in heavy development and very incomplete. Its scope, features, and roadmap are subject to change as the project evolves. + +--- + +## 🚀 Planned Feature Set + +### Core Features +- [ ] **Server Management** + - [ ] Manage **stateless** servers (e.g., minigames) + - [ ] Manage **stateful** servers (e.g., SMP) + - [x] Manage **Velocity reverse proxy** servers + - [ ] Dynamic scaling for stateless server + +- [ ] **Integration with Velocity** + - [x] Dynamically manage backends + - [x] **Proxy Transfers** - Seamlessly transfer players between proxies + - [x] [ValioBungee](https://www.spigotmc.org/resources/valiobungee.87700/) (RedisBungee) integration + - [ ] **Load Balancing** + +### User Experience +- [ ] **Frontend** + - Web interface for managing servers and configurations. + +### Kubernetes +- [ ] **Managed deployment in Kubernetes Clusters** + +--- + +## 📌 Additional Features In Consideration + +### Advanced Server Management +- [ ] Automatic backups and restore +- [ ] Scheduled server start/stop to save resources + +### Plugins +- [ ] Management for server jar versions, plugins, and mods + +### API & Extensibility +- [ ] REST/GraphQL API for programmatic control