Skip to content

Latest commit

 

History

History
90 lines (59 loc) · 6.46 KB

README.md

File metadata and controls

90 lines (59 loc) · 6.46 KB
Mach is still early stages - see what we have today and stay tuned

Mach: game engine & graphics toolkit for the future

Written in Zig, Mach is for creating games, graphical applications, and desktop/mobile apps:

  • Data-driven, tooling oriented
  • Composable
  • Competitive with Unity and Unreal in spirit (a fully fledged editor in the future, etc.)

example-advanced-gen-texture-light example-boids example-textured-cube

Example showcase

Cross-platform graphics in ~60 seconds

git clone https://github.com/hexops/mach
cd mach/
zig build run-example-boids

Cross-platform graphics, a unified shader language & compute shaders.

(Requires zig 0.10.x | known issues)

Libraries

Mach has many libraries you can use for game development in Zig - you don't have to use the entire engine. All our libraries aim to have the same zero-fuss installation, cross compilation, and platform support:

  • mach-glfw: Ziggified GLFW bindings with 100% API coverage
  • mach-freetype: Ziggified Freetype 2 & HarfBuzz bindings
  • mach-gpu-dawn: Google's Dawn WebGPU implementation, cross-compiled with Zig into a single static library
  • mach-system-sdk: More libraries for cross-compilation with Zig

Join the community

Contributors are very welcome! There are lots of places you can help out with little knowledge, so feel free to join the Matrix chat and say hi!

Sponsor development

No, it’s not Tom from myspace - it’s me, @slimsag! It’s taken almost a year to get here - staring at broken CI pipelines, C++ compiler errors, buying hardware to test every OS+arch possible, and more.

There are few things in life that I am more serious about than this work. I dedicate ~48 hours/week to my dayjob, and ~50h/week to Zig building Mach and running zigmonthly.org. After three years of aggressively pushing for progress in this exact way, I have no plans to slow down anytime soon.

Supported platforms

Mach is still early stages, so far we have support for building from the following OS to the following targets:

Building for From macOS x86_64 From macOS M1/aarch64 From Linux x86_64 From Windows x86_64
macOS x86_64
macOS M1/aarch64
Linux x86_64
Windows x86_64
iOS 🏃 🏃 🏃 🏃
Android 🏃 🏃 🏃 🏃
Web (Wasm) 🏃 🏃 🏃 🏃
  • ✅ Tested and verified via CI.
  • ✔️ Should work, not tested via CI yet.
  • 🏃 Planned or in progress.
  • ⚠️ Implemented, but has known issues (e.g. bugs in Zig.)

Supported Zig version

Mach works with the new self-hosted Zig compiler only. This means you'll need to use the latest Zig nightly version.

Currently we test using 0.10.0-dev.3952+9e070b653. Newer is generally better, but you can download this version here:

mach/ecs and WebAssembly examples have known issues unless using -fstage1, see issue #180 for details.

Contributing

Mach is maintained as a monorepo. When changes are merged to this repository, we use some git-fu to pick out the commits to subdirectories and push them to sub-repositories automagically. Changes to the glfw/ directory in this repository get pushed to the separate mach-glfw repository after being merged here, for example.

Please prefix commits / pull requests with the project name (glfw: fix an issue, gpu: fix an issue, examples: fix an issue, etc.) and if possible only one project per commit. If you don't know how to do this, no worries, we can help - just send your PR anyway!