zig/mach

No description

Find a file

Stephen Gutekanst 77d2e8a9a3 glfw: improve consecutive build times by 4-12x This substantially reduces consecutive build times when using mach/glfw. `system_sdk.getSdkPath` is frequently invoked as part of the build process, and previously it was doing some fairly involved work (ensuring the native SDK is at the right revision, needless `git fetch` in native SDKs to check for updates, etc.) We now do far less work in `getSdkPath`, and additionally cache the result in-memory. This improves build times substantially, but especially so with consecutive (non-cold-cache) build times: * For `mach/glfw`: ~2s before, ~160ms after * For `mach/gpu`: , ~16s before, ~3.6s after Signed-off-by: Stephen Gutekanst <stephen@hexops.com>		2021-12-10 03:40:00 -08:00
.github	CI: update to latest Zig master	2021-12-06 20:03:38 -08:00
dev	move GLFW into sub-repository, use git subtree to sync (#42 )	2021-10-24 07:19:38 -07:00
glfw	glfw: improve consecutive build times by 4-12x	2021-12-10 03:40:00 -08:00
gpu	gpu: update to latest Zig master version (allocgate)	2021-12-06 20:03:38 -08:00
src	glfw: add terminate function	2021-07-16 15:24:45 -07:00
.gitattributes	initialize repository	2021-07-04 10:36:34 -07:00
.gitignore	gitignore: update to latest from ziglang/zig repo	2021-07-06 20:51:19 -07:00
.gitmodules	webgpu: rename to just "gpu"	2021-11-21 08:32:03 -07:00
build.zig	constify unmutated variables in build files	2021-11-22 12:59:11 -07:00
LICENSE	LICENSE: note directories with a separate LICENSE file	2021-07-05 12:46:20 -07:00
LICENSE-APACHE	initialize repository	2021-07-04 10:36:34 -07:00
LICENSE-MIT	initialize repository	2021-07-04 10:36:34 -07:00
README.md	README: regenerate sponsors section	2021-11-15 22:37:30 +00:00

README.md

Mach - Game engine & graphics toolkit for the future

Mach engine

⚠️ Project status: in-development ⚠️

Under heavy development, not ready for use currently. Follow @machengine on Twitter for updates.

News

You can read about major Mach engine developments at devlog.hexops.com:

Zero fuss installation & cross compilation

Mach is built from the ground up to support zero fuss installation & cross compilation, only zig and git are needed to build from any OS and produce binaries for every platform.

If you've ever worked with game engines in C, C++, Rust, Go, or any other language you've probably run into issues at one point getting the right system dependencies installed, whether it be library versions, compilers, system SDKs, X11/GLFW/SDL C dependencies, etc. With Mach, none of this is needed - it's all sorted out for you automagically.

Mach is able to do this thanks to Zig being a C/C++ compiler, Zig's linker zld supporting macOS cross compilation, and us doing the heavy lifting of packaging the required system SDK libraries and C sources for every dependency we need so our Zig build scripts can simply git clone them for you as needed for the target OS you're building for, completely automagically.

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.)

Libraries for all

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

About sub-repositories

In this repository, we maintain Mach as a monorepo. We pull in all commits from our library sub-repositories listed above using git subtree:

git subtree pull --prefix glfw https://github.com/hexops/mach-glfw main

This pulls in all commits from our sub-repositories, and effectively leads to a full history of all Mach development across all core repositories.

Pull requests can be made to any repository (we synchronize both ways via git subtree pull and git subtree push.)

There are only two requirements:

Pull requests in sub-repositories must have a commit message prefix, e.g. glfw: <commit message> to keep our monorepo history nicer - we generally squash merge pull requests so this is not an issue.
Pull requests to this repository may not change multiple sub-repositories in the same commit (e.g. a commit to glfw/ should not also include changes to webgpu/, to avoid confusion.)