Standard library

The Mach standard library can be found at: github.com/hexops/mach - it is modular by design. Just like the Zig standard library, you can choose which parts to use or not.

Thanks to Zig’s lazy code evaluation and lazy dependency fetching, you really only pay for the parts you use.

Choosing your Mach version

0.4 branch (not actively developed, but more stable)

The 0.4 branch is what applications like Pixi and games like #lordofzero (in the Discord) are using. It uses GLFW, WebGPU, and optionally the ECS. It is no longer in development however.

To use this version, see the /v0.4 website mach core getting started guide.

main branch (actively developed, experimental/unstable)

This branch is where active development is happening, we are removing GLFW and WebGPU in favor of our own packages (more details) which means it is not stable - or may not even run - on some OS. At the time of writing Sep 30th, Windows is relatively stable, Linux might work under Wayland, and macOS is not expected to work currently.

To use this version, add the Mach dependency to your build.zig.zon file:

zig fetch --save https://pkg.machengine.org/mach/$LATEST_COMMIT.tar.gz

Using the dependency

Then make it importable by your code in build.zig, e.g.:

pub fn build(b: *std.Build) void {
    // ...

    // Add Mach to our library and executable
    const mach_dep = b.dependency("mach", .{
        .target = target,
        .optimize = optimize,
    });
    lib.root_module.addImport("mach", mach_dep.module("mach"));
    exe.root_module.addImport("mach", mach_dep.module("mach"));
}

Now in e.g. your src/main.zig you can @import("mach").

(optional) Lazy dependencies

Mach’s stdlib has a handful of external dependencies, downloading them all is usually not a problem. Optionally, if you want to optimize your build and only download what is absolutely neccessary, you can specify which parts of the Mach stdlib you use and have only the dependencies needed for those parts downloaded.

For example, in your build.zig you might specify:

    const mach_dep = b.dependency("mach", .{
        .target = target,
        .optimize = optimize,

        // We only use mach.core and mach.sysaudio, so only fetch the dependencies needed by those.
        .core = true,
        .sysaudio = true,
    });

The options are:

An option is only provided if that portion of the stdlib has external dependencies. Remember that Zig’s lazy code evaluation effectively means time is only spent compiling the code you reference.

Ran into trouble?

Feel free to join the Mach Discord community for help.