diff --git a/README.md b/README.md index fb071cd2..c0cb205d 100644 --- a/README.md +++ b/README.md @@ -1,90 +1,20 @@ -
Mach is still early stages - see what we have today and stay tuned
+ + + + mach-opus + + -# Mach: game engine & graphics toolkit for the future +Zig game engine & graphics toolkit for building high-performance, truly cross-platform, robust & modular games, visualizations, and desktop/mobile GUI apps. -Written in [Zig](https://ziglang.org/), Mach is for creating games, graphical applications, and desktop/mobile apps: +gen-texture-light +boids +textured-cube -- Data-driven, tooling oriented -- Composable -- Competitive with Unity and Unreal in spirit (a fully fledged editor in the future, etc.) +## Learn more -example-advanced-gen-texture-light -example-boids -example-textured-cube - -[Example showcase](https://machengine.org/gpu/) - -## Cross-platform graphics in ~60 seconds - -```sh -git clone https://github.com/hexops/mach-examples -cd mach-examples/ -zig build run-sprite2d -``` - -Cross-platform graphics, a unified shader language & compute shaders. - -(Requires [zig 0.11.x](https://ziglang.org/) | [known issues](https://github.com/hexops/mach/blob/main/doc/known-issues.md#known-issues)) - -## Get started with 15+ examples - -* Examples showcase: https://machengine.org/gpu/ - -## 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](https://github.com/hexops/mach-glfw): Ziggified GLFW bindings with 100% API coverage -- [mach-freetype](https://github.com/hexops/mach-freetype): Ziggified Freetype 2 & HarfBuzz bindings -- [mach-gpu-dawn](https://github.com/hexops/mach-gpu-dawn): Google's Dawn WebGPU implementation, cross-compiled with Zig into a single static library +[machengine.org](https://machengine.org) ## Join the community -- [Mach Discord server](https://discord.gg/XNG3NZgCqp) - come discuss the future of game engines & graphics in Zig! -- [machengine.org](https://machengine.org) -- Follow [@machengine on Twitter](https://twitter.com/machengine) for updates. - -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](https://devlog.hexops.com/2022/mach-v0.1-zig-graphics-in-60s) - staring at broken CI pipelines, C++ compiler errors, [buying hardware](https://twitter.com/slimsag/status/1507506138144681986) 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](https://zigmonthly.org). After three years of aggressively pushing for progress in this exact way, [I have no plans to slow down anytime soon.](https://devlog.hexops.com/2021/i-write-code-100-hours-a-week) - -## 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.12.0-dev.21+ac95cfe44`. Newer is generally better, but you can download this version here: - -- **linux-x86_64**: https://pkg.machengine.org/zig/zig-linux-x86_64-0.12.0-dev.21+ac95cfe44.tar.xz -- **windows-x86_64**: https://pkg.machengine.org/zig/zig-windows-x86_64-0.12.0-dev.21+ac95cfe44.zip -- **macos-x86_64** (Intel): https://pkg.machengine.org/zig/zig-macos-x86_64-0.12.0-dev.21+ac95cfe44.tar.xz -- **macos-aarch64** (Apple Silicon): https://pkg.machengine.org/zig/zig-macos-aarch64-0.12.0-dev.21+ac95cfe44.tar.xz - -## Contributing - -Please prefix commits / pull requests with the project name (`editor: fix an issue`, `math: fix an issue`, etc.) If you -don't understand, no worries - just send your PR anyway! +Join the [Mach community on Discord](https://discord.gg/XNG3NZgCqp) to discuss this project, ask questions, get help, etc.