Steel

Steel is a lightweight Rust implementation of the Minecraft server. It focuses on clean code, performance, extensibility, and ease of use.

---

🔗 Links

Discord | GitCraft

---

⚙ How to Contribute

1. Identify a feature you'd like to add or an issue to work on. You should always create a post in the channel feature-discussion when considering adding a major feature.
2. Decompile Minecraft 1.21.11 by running the provided script:

   ./update-minecraft-src.sh

   This will clone GitCraft and generate the decompiled source in minecraft-src/.
3. Fork the master branch of this repository.
4. Examine the vanilla implementation and translate it into idiomatic Rust as cleanly and efficiently as possible.
5. Commit your changes to your fork and open a pull request.

Note

It is highly recommended to join the Discord server and reach out to 4lve if you have code-related questions or encounter any ambiguities.

Important

This project is still in a very early stage of development.

Precommit Hook

This repository uses prek to ensure that all commits follow the style guide and makes sure the cicd will pass. To install the hook, some things needed to be installed first:

cargo install prek typos-cli --locked

Then you can run prek install to install the hook and it is configured to run automatically before every commit. It will fix some things already for you, but the commit will still fail and please check the changes.