From 870cfa71e9a9249c4d5f6826e1c9ddb27c9da37b Mon Sep 17 00:00:00 2001 From: norbiros Date: Thu, 18 Sep 2025 15:21:42 +0200 Subject: [PATCH] docs: completely rewrite `profile/README.md` --- profile/README.md | 58 +++++++++++++++++++++++++++++++++++++++++------ 1 file changed, 51 insertions(+), 7 deletions(-) diff --git a/profile/README.md b/profile/README.md index e279bd5..09874a5 100644 --- a/profile/README.md +++ b/profile/README.md @@ -1,11 +1,55 @@ # 🦀 CrabCraft -Minecraft server written in Rust. +**CrabCraft** is an ambitious **Minecraft server written in Rust**. +Built for speed, scalability, and modern development practices. -If you want to get in touch, join our [Discord server](https://discord.gg/ZSqcGUHD48)! +👉 Join our [Discord community](https://discord.gg/ZSqcGUHD48) to contribute, ask questions, or just hang out. -> [!IMPORTANT] -> -> CrabCraft is in very early stages of development.
-> Source code will be published after we reach `v0.1.0` -> +## 🚀 Vision + +CrabCraft aims to be: + +* **Fast and safe:** A Minecraft server powered by Rust’s performance and memory safety. +* **Developer-friendly:** Designed for developers & contributors, even outside the Rust ecosystem. +* **Collaborative and fun:** A project where developers can learn, grow, and build together. + +We’re still in the early stages. Code will be published once the project reaches a point we’re proud to share. + +Benchmarks and comparisons with existing servers will follow later. + +## 🛠️ Projects + +CrabCraft is not just one program but a collection of tools and crates that form the ecosystem: + +* **CrabCraft** — 🦀 The Rust-based Minecraft server. *(Rust)* +* [**CrabNBT**](https://github.com/CrabCraftDev/CrabNBT) — 📜 A modern Rust crate for intuitive NBT data handling. *(Rust)* +* **CrabExtractor** — 🚜 A simple mod for extracting Minecraft data. *(Java)* +* **CrabToolbox** — 🔧 Helper tools for faster CrabCraft development. *(Python)* +* [**CrabEvenio**](https://github.com/CrabCraftDev/CrabEvenio) — 🐄 An event-driven ECS framework. *(Rust)* + +More components are planned or under development, but not yet public. + +## 👥 Join the Team + +CrabCraft is more than just software. It’s a place to **learn** software development and collaboration on something real and big. + +### What You’ll Gain + +* A welcoming and inclusive community. +* Hands-on experience with Rust, Java/Kotlin, Python, and web tech. +* Deep dives into real-world scaling challenges. +* Constructive code reviews and knowledge sharing. +* Opportunities to solve complex, interesting problems. + +### Who We’re Looking For + +Anyone passionate and curious. +No Minecraft server experience required—just enthusiasm and willingness to learn. + +📩 Interested? Join us on [Discord](https://discord.gg/ZSqcGUHD48). + +## ⚠️ Disclaimer + +CrabCraft is **not an official Minecraft product** and is **not affiliated with Mojang or Microsoft**. + +We don’t claim superiority over existing server software today. Success isn’t guaranteed. But if CrabCraft succeeds, it will change the landscape of Minecraft server development.