Reference#

Void is a Minecraft-compatible server framework written in Rust. It combines Bevy ECS for game logic with Tokio for asynchronous networking, giving you a modular, high-performance foundation for building custom Minecraft servers.

Crate Structure#

Quick Start#

Add void as a dependency, then create a minimal server:

use voidmc::{
    CommandBuilder, CommandRegistry, ServerBuilder, VoidServer,
    register_default_commands,
};

fn main() {
    VoidServer::new(ServerBuilder::new().build())
        .add_plugin(|app| {
            let mut registry = app.world_mut().resource_mut::<CommandRegistry>();
            register_default_commands(&mut registry, &[]);
        })
        .add_command(
            CommandBuilder::new("hello")
                .description("Greet the player")
                .handler(|ctx| {
                    ctx.reply("Hello from my server!");
                })
                .build(),
        )
        .run();
}

This starts a server on 127.0.0.1:25565 with default settings, all built-in commands, and a custom /hello command.

Server#

• Architecture — Dual-threaded model, tick loop, plugin system, packet flow
• Configuration — ServerBuilder API, ServerConfig fields, defaults
• ECS Components & Resources — All components, resources, and entity lifecycle
• Events — Semantic events, packet events, observer pattern

Protocol & Codec#

• Networking & Protocol — Protocol states, connection lifecycle, keep-alive
• Binary Codec — Encode/Decode traits, derive macros, field attributes

Gameplay#

• Command System — CommandBuilder, argument parsers, flags, default commands
• Player Management — Join/quit flow, visibility, position broadcasting, teleportation
• World & Chunks — Chunk system, dimensions, streaming, world generators
• Registry System — RegistryDataStore API, default registries, customization

Vanilla Data#

• Vanilla Data (voidmc-data) — Build-time codegen for blocks, states, collision shapes, and registries