GitHub repository | Issue tracker

The Mach entity component system, written from first-principles and designed for deep tooling capabilities.

• Initially a 100% clean-room implementation, working from first-principles; later informed by research into how other open-source ECS work.
• Enable deep tooling to provide tracing, editors, visualizers, profilers, etc.
• Fast, optimal for CPU caches, multi-threaded, leverage comptime for type safety.
• Dynamic, allow for very flexible runtime capabilities.

We’re publishing a blog series “Let’s build an Entity Component System from scatch” as we go.

Experimental

This is an experimental project according to our stability guarantees:

When a project has an experimental warning, it means all bets are off. You should carefully read the warning to understand why the project is experimental, and assume the worst.

Tracking issue: https://github.com/hexops/mach/issues/968

Getting started

Create a build.zig.zon in your project (replace LATEST_COMMIT with the latest commit hash):

.{
    .name = "mypkg",
    .version = "0.1.0",
    .dependencies = .{
        .mach_ecs = .{
            .url = "https://pkg.machengine.org/mach-ecs/LATEST_COMMIT.tar.gz",
        },
    },
}

Run zig build in your project, and the compiler will instruct you to add a .hash = "..." field next to .url:

note: expected .hash = "12209838fcfb7a77d2d6931efdc7448c033a1b7dad11d082c94bbeeba9d1038cd311",

Then use the dependency in your build.zig:

pub fn build(b: *std.Build) void {
    ...
    exe.addModule("mach-ecs", b.dependency("mach_ecs", .{
        .target = target,
        .optimize = optimize,
    }).module("mach-ecs"));
}

You can now use it in your src/main.zig file:

const ecs = @import("mach-ecs");

Ran into trouble?

Triple-check you followed the build.zig.zon instructions correctly, it’s easy to mess that part up.

Feel free to join the Mach Discord community for help.