Skip to content

A high-performance Minecraft server written in Rust.

License

Notifications You must be signed in to change notification settings

ObsidiumMC/Obsidium

Repository files navigation

Obsidium

A high-performance Minecraft server written in Rust.

Code Quality Checks Minecraft Version Rust Version License: MIT

Discord Server

Current State

Obsidium is unfortunately inactive because I haven't had much time to work on it. Otherwise, I would love to finish the project... it was created for fun and learning in the end.

What works:

  • The server starts and listens for connections.
  • Clients can see the server in their multiplayer list (server list ping).
  • Players can successfully connect and log in, passing the handshaking, login, and configuration states.

What does not work:

  • Players cannot spawn in the world yet.

Getting Started

The easiest way to run Obsidium is to use a pre-built binary from the Releases page.

  1. Download the executable for your operating system (Windows, Linux, or macOS).
  2. Run the executable from your terminal.

That's it! The server is now running on your machine at localhost:25565.

Building from Source

If you want to contribute or build the server yourself, you'll need the Rust toolchain.

  1. Install Rust: Get it from rustup.rs.
  2. Clone the repository:
    git clone https://github.com/ObsidiumMC/Obsidium.git
    cd Obsidium
  3. Run the server:
    cargo run

Contributing

Please read CONTRIBUTING.md for more details. For real-time discussion with developers, join our Discord Server.

License

This project is licensed under the MIT License.

About

A high-performance Minecraft server written in Rust.

Resources

License

Contributing

Stars

Watchers

Forks

Packages

No packages published

Languages