diff --git a/config.toml b/config.toml index c9a6ce84..42d2c36f 100644 --- a/config.toml +++ b/config.toml @@ -245,12 +245,6 @@ unsafe = true name = 'dxcompiler' url = '/pkg/mach-dxcompiler' weight = 3400 -[[menu.pkg]] - identifier = 'pkg-bind-model3d' - parent = 'pkg-bind' - name = 'model3d' - url = '/pkg/mach-model3d' - weight = 3500 [[menu.pkg]] identifier = 'pkg-bind-opus' parent = 'pkg-bind' diff --git a/content/_index.md b/content/_index.md index 2b024915..b7a0b234 100644 --- a/content/_index.md +++ b/content/_index.md @@ -454,12 +454,6 @@ $ zig build -Dtarget=aarch64-macos mach-basisu - - - - mach-model3d - - diff --git a/content/pkg/_index.md b/content/pkg/_index.md index ed62de15..034bad03 100644 --- a/content/pkg/_index.md +++ b/content/pkg/_index.md @@ -62,12 +62,6 @@ Mach provides an ecosystem of 100% standalone, high-quality Zig gamedev packages mach-basisu - - - - mach-model3d - - diff --git a/content/pkg/mach-model3d.md b/content/pkg/mach-model3d.md index 8f1a7e1d..82f83585 100644 --- a/content/pkg/mach-model3d.md +++ b/content/pkg/mach-model3d.md @@ -7,72 +7,8 @@ docs_type: "pkg" rss_ignore: true --- -
- - - mach-model3d - - - GitHub repository | Issue tracker - -
+No longer supported as an official Mach project. The code has moved to [github.com/slimsag/mach-model3d](https://github.com/slimsag/mach-model3d) and may not be maintained to the same standard as official Mach projects. -Compact, featureful model format & alternative to glTF. +**Additional details:** https://github.com/hexops/mach/issues/969 -[Model3D](https://gitlab.com/bztsrc/model3d/) is an up-and-coming compact, featureful, universal model format that tries to address the shortcomings of existing formats (yes, including glTF - see [their rationale](https://gitlab.com/bztsrc/model3d/#rationale).) - -## Experimental - -This is an **experimental** project according to [our stability guarantees](../../about/stability): - -> When a project has an experimental warning, it means all bets are off. You should carefully read the warning to understand why the project is experimental, and assume the worst. - -**Tracking issue:** https://github.com/hexops/mach/issues/969 - -## Getting started - -Create a `build.zig.zon` in your project (replace `LATEST_COMMIT` with the latest commit hash): - -```zig -.{ - .name = "mypkg", - .version = "0.1.0", - .dependencies = .{ - .mach_model3d = .{ - .url = "https://pkg.machengine.org/mach-model3d/LATEST_COMMIT.tar.gz", - }, - }, -} -``` - -Run `zig build` in your project, and the compiler will instruct you to add a `.hash = "..."` field next to `.url`: - -``` -note: expected .hash = "12209838fcfb7a77d2d6931efdc7448c033a1b7dad11d082c94bbeeba9d1038cd311", -``` - -Then use the dependency in your `build.zig`: - -```zig -pub fn build(b: *std.Build) void { - ... - exe.root_module.addImport("mach-model3d", b.dependency("mach_model3d", .{ - .target = target, - .optimize = optimize, - }).module("mach-model3d")); -} -``` - -You can now use it in your `src/main.zig` file: - -```zig -const model3d = @import("mach-model3d"); -``` - -For usage examples, you can look at the mach-core [pbr-basic example](https://github.com/hexops/mach-core/blob/main/examples/pbr-basic/main.zig) - note that a `vertex_writer.zig` helper is needed due to the way model3d stores data. - -### Ran into trouble? - -Triple-check you followed the `build.zig.zon` instructions correctly, it's easy to mess that part up. - -Feel free to join the [Mach Discord community](../../discord) for help. +**View the older v0.3 documentation:** https://machengine.org/v0.3/pkg/mach-model3d