zig-gamedev 项目

自 2021 年 7 月起，每天都在为 Zig 编程语言构建游戏开发生态系统。请考虑支持该项目。我们创造:

• 跨平台和可组合库
• 跨平台示例应用程序
• DirectX 12 示例应用程序

请注意，Zig 仍处于开发阶段。我们的主分支定期更新 Zig 编译器的版本，目前为 0.12.0-dev.1871+e426ae43a，可通过以下链接下载。

如果需要使用较新版本的 Zig，可以使用我们的不稳定分支。但一般不建议使用。

要在 Windows/Linux/MacOS 上开始使用，请尝试基于物理的渲染 (wgpu) 示例：

git clone https://github.com/zig-gamedev/zig-gamedev.git
cd zig-gamedev
zig build physically_based_rendering_wgpu-run

快速开始 (D3D12)

要在项目中使用 zig-gamedev，可复制或下载 zig-gamedev 作为子模块：

git submodule add https://github.com/zig-gamedev/zig-gamedev.git libs/zig-gamedev

目前，我们有最基本的底层应用程序接口，可以让您一次构建 lib（package()），并将其与多个可执行文件链接（link()）。

在 build.zig 中包含必要的库：

// Fetch the library
const zwin32 = @import("src/deps/zig-gamedev/libs/zwin32/build.zig");

// Build it
const zwin32_pkg = zwin32.package(b, target, optimize, .{});

// Link with your app
zwin32_pkg.link(exe, .{ .d3d12 = true });

Example build script:

const std = @import("std");
const zwin32 = @import("libs/zig-gamedev/libs/zwin32/build.zig");
const common = @import("libs/zig-gamedev/libs/common/build.zig");
const zd3d12 = @import("libs/zig-gamedev/libs/zd3d12/build.zig");

pub fn build(b: *std.Build) void {
    const target = b.standardTargetOptions(.{});

    const optimize = b.standardOptimizeOption(.{});

    const exe = b.addExecutable(.{
        .name = "example",
        .root_source_file = .{ .path = "src/main.zig" },
        .target = target,
        .optimize = optimize,
    });

    b.installArtifact(exe);

    const run_cmd = b.addRunArtifact(exe);

    run_cmd.step.dependOn(b.getInstallStep());

    if (b.args) |args| {
        run_cmd.addArgs(args);
    }

    const zwin32_pkg = zwin32.package(b, target, optimize, .{});
    const zd3d12_pkg = zd3d12.package(b, target, optimize, .{
        .options = .{
            .enable_debug_layer = false,
            .enable_gbv = false,
            .enable_d2d = true,
        },
        .deps = .{ .zwin32 = zwin32_pkg.zwin32 },
    });
    const common_d2d_pkg = common.package(b, target, optimize, .{
        .deps = .{ .zwin32 = zwin32_pkg.zwin32, .zd3d12 = zd3d12_pkg.zd3d12 },
    });

    zwin32_pkg.link(exe, .{ .d3d12 = true });
    zd3d12_pkg.link(exe);
    common_d2d_pkg.link(exe);

    const run_step = b.step("run", "Run the app");
    run_step.dependOn(&run_cmd.step);
}

愿景

• 非常模块化的 "库工具箱"，用户可以只使用自己需要的组件
• 可在 Windows、macOS 和 Linux 上运行
• 除 Zig 编译器（master）和带有 Git LFS 的 git 外，零依赖 - 无需 Visual Studio、Build Tools、Windows SDK、gcc、dev 包、系统头文件/libs、cmake、ninja 等。
• 构建就像运行 zig build 一样简单（参见：构建）
• 用 Zig 从头开始编写库，或为精心挑选的 C/C++ 库提供 Ziggified 绑定
• 使用本地 wgpu 实现（Dawn）或 OpenGL 实现跨平台图形，在 Windows 上使用 DirectX 12 实现底层图形

示例应用程序（本地 wgpu）

下面列出了部分示例应用程序。更多示例可在示例目录中找到。

1. physically based rendering (wgpu) : 该示例实现了基于物理的渲染（PBR）和基于图像的照明（IBL），以获得逼真的渲染效果。 zig build physically_based_rendering_wgpu-run

2. audio experiments (wgpu) : 该样本可让用户进行音频实验，并观察为硬件提供的数据。 zig build audio_experiments_wgpu-run

3. bullet physics test (wgpu) :该示例程序演示了如何在 Zig 程序中使用全 3D 物理引擎。 zig build bullet_physics_test_wgpu-run

4. procedural mesh (wgpu) : 该示例展示了如何高效绘制多个程序生成的网格。 zig build procedural_mesh_wgpu-run

5. gui test (wgpu) : 该示例展示了如何使用我们的 zgui 库。 zig build gui_test_wgpu-run

示例应用程序（DirectX 12）

下面列出了部分示例应用程序。更多示例可在示例目录中找到。它们可以在 Windows 和 Linux（Wine + VKD3D-Proton 2.8+）上构建和运行：

1. bindless : 该示例实现了基于物理的着色和基于图像的照明，以达到逼真的渲染效果。它使用无绑定纹理和 HLSL 6.6 动态资源。 zig build bindless-run

2. rasterization : 此示例应用程序展示了 GPU 如何以慢动作光栅化三角形。 zig build rasterization-run

3. simple raytracer : 该示例实现了基本的混合渲染器。它使用光栅化来解析主光线，并使用光线跟踪（DXR）来解析阴影光线。 zig build simple_raytracer-run

4. mesh shader test : 本示例演示了如何使用 DirectX 12 网格着色器。 zig build mesh_shader_test-run

zig-gamedev其他用法

• Aftersun - 自上而下的 2D RPG https://github.com/foxnne/aftersun
• Pixi - 使用 Zig 制作的像素艺术编辑器 https://github.com/foxnne/pixi
• Simulations - 基于 GPU 加速的代理建模可视化和模拟复杂系统 https://github.com/ckrowland/simulations
• elvengroin legacy - TBD
• jok - 适用于 Zig 的最小 2D/3D 游戏框架 https://github.com/jack-ji/jok

构建示例应用程序

编译所有示例应用程序（假设 PATH 中有 zig 且已安装 Git LFS）：

1. git clone https://github.com/zig-gamedev/zig-gamedev.git
2. cd zig-gamedev
3. zig build

构建工件将显示在 zig-out/bin 文件夹中。

zig build <sample_name> 命名成 <sample_name> .

zig build <sample_name>-run 构建并运行名为 <sample_name> .

要列出所有可用的样本名称，请运行 zig build --help 并导航至步骤部分。

构建选项

优化选项:

• -Doptimize=[Debug|ReleaseFast|ReleaseSafe|ReleaseSmall] - enable optimizations

应用程序优化:

• -Dzd3d12-enable-debug-layer=[bool] - Direct3D 12, Direct2D, DXGI debug layers enabled
• -Dzd3d12-enable-gbv=[bool] - Direct3D 12 GPU-Based Validation (GBV) enabled
• -Dzpix-enable=[bool] - PIX markers and events enabled