Since we're not specifying a sysroot by default (as that prevents making use of other libraries/headers on your system, if you wish to) we can have conflicts with either the headers on your system or the headers Zig itself ships (although that shouldn't happen, except for cases like Windows where we ship more up-to-date DirectX headers.) System include dirs are treated with the same relative priority as other system include dirs, those actually on your system and the ones Zig provides. But regular include dirs are given higher priority, and so should give our headers a better chance of being included in the event that there should be any conflict. Signed-off-by: Stephen Gutekanst <stephen@hexops.com> |
||
|---|---|---|
| .github | ||
| dev | ||
| ecs | ||
| glfw | ||
| gpu-dawn | ||
| src | ||
| .gitattributes | ||
| .gitignore | ||
| .gitmodules | ||
| build.zig | ||
| LICENSE | ||
| LICENSE-APACHE | ||
| LICENSE-MIT | ||
| README.md | ||
Learn more at hexops.com/mach
Join the conversation
Our community exists on Matrix chat, join in and help build the future of game engines & graphics in Zig!
You can also follow @machengine on Twitter for updates.
⚠️ in-development ⚠️
Under heavy development, not ready for use currently.
Supported platforms
Mach is still incredibly 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 | 🏃 | 🏃 | 🏃 | 🏃 |
- ✅ 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.)
Subrepositories / projects
Whether you're interested in using all of Mach, or just some parts of it, you get to choose. Our libraries all aim to have the same zero-fuss installation, cross compilation, and platform support:
- mach-glfw: Ziggified GLFW bindings with 100% API coverage
Contributing
Mach is maintained as a monorepo. When changed are merged to this repository, we use some git fu to pick out the commits to subdirectories and push them ot sub-repositories. For example, commits to the glfw/ directory also get pushed to the separate mach-glfw repository after being merged here.
There are only two requirements:
- Pull requests to sub-repositories must be sent to this monorepo, not to the sub-repository itself - to avoid some annoying merge conflicts that can arise.
- Individual commits may not change multiple sub-repositories at the same time (e.g. a commit to
glfw/cannot also include changes togpu/, to avoid confusion.)