mach/libs/core
Stephen Gutekanst 816b5101b3 core: use mach-sysjs via package manager
Signed-off-by: Stephen Gutekanst <stephen@hexops.com>
2023-05-19 08:21:31 -07:00
..
.github all: update Zig to version 0.11.0-dev.2868+1a455b2dd 2023-04-28 16:00:21 -07:00
include core: libmachcore fixes 2023-02-07 19:00:36 -07:00
libs core: use mach-sysjs via package manager 2023-05-19 08:21:31 -07:00
src core: make default window size 1/2 1920x1080 2023-05-17 20:29:41 -07:00
.gitattributes libs/core: initialize subproject from dev/template 2023-01-24 18:14:52 -07:00
.gitignore libs/core: initialize subproject from dev/template 2023-01-24 18:14:52 -07:00
build.zig core: use mach-sysjs via package manager 2023-05-19 08:21:31 -07:00
build.zig.zon core: use mach-sysjs via package manager 2023-05-19 08:21:31 -07:00
LICENSE libs/core: initialize subproject from dev/template 2023-01-24 18:14:52 -07:00
LICENSE-APACHE libs/core: initialize subproject from dev/template 2023-01-24 18:14:52 -07:00
LICENSE-MIT libs/core: initialize subproject from dev/template 2023-01-24 18:14:52 -07:00
README.md core: add experimental warning 2023-04-05 03:07:18 -07:00
sdk.zig core: use mach-sysjs via package manager 2023-05-19 08:21:31 -07:00

mach/core: a modern alternative to SDL/etc

This repository is a separate copy of the same library in the main Mach repository, and is automatically kept in sync, so that anyone can use this library in their own project if they like!

Experimental

This is an experimental Mach library, according to our stability guarantees:

Experimental libraries may have their APIs change without much notice, and you may have to look at recent changes in order to update your code.

Why this library is not declared stable yet

Window+Input+GPU, nothing else.

mach/core provides the power of Vulkan, DirectX, Metal, and modern OpenGL in a single concise graphics API - by compiling Google Chrome's WebGPU implementation natively via Zig (no cmake/ninja/gn/etc) into a single static library.

Supports Windows, Linux, and macOS today. WebAssembly and Mobile will also be supported under the same API in the near future.

Learn more: https://machengine.org/docs/core

Getting started

Adding dependency

In a libs subdirectory of the root of your project:

git clone https://github.com/hexops/mach-core

Then in your build.zig add:

...
const core = @import("libs/mach-core/build.zig");

pub fn build(b: *Build) void {
    ...
    exe.addModule("core", core.module(b));
    core.link(b, exe, .{});
}

Join the community

Join the Mach community on Discord to discuss this project, ask questions, get help, etc.

Issues

Issues are tracked in the main Mach repository.

Contributing

Contributions are very welcome. Pull requests must be sent to the main repository to avoid some complex merge conflicts we'd get by accepting contributions in both repositories. Once the changes are merged there, they'll get sync'd to this repository automatically.