Skip to content

docs: completely rewrite profile/README.md #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Norbiros wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: completely rewrite profile/README.md #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 51 additions & 7 deletions profile/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.<br>
> 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.