Zig-ECS 项目使用教程

Zig-ECS 项目使用教程

zig-ecs项目地址:https://gitcode.com/gh_mirrors/zi/zig-ecs

1. 项目的目录结构及介绍

zig-ecs/
├── examples/
│   ├── basic_example.zig
│   └── advanced_example.zig
├── src/
│   ├── ecs.zig
│   └── components.zig
├── tests/
│   ├── test_ecs.zig
│   └── test_components.zig
├── .gitignore
├── .gitmodules
├── LICENSE
├── README.md
├── build.zig
└── build.zig.zon

• examples/: 包含项目的示例代码，如 basic_example.zig 和 advanced_example.zig。
• src/: 项目的源代码目录，包含核心文件如 ecs.zig 和 components.zig。
• tests/: 项目的测试代码目录，包含测试文件如 test_ecs.zig 和 test_components.zig。
• .gitignore: Git 忽略文件配置。
• .gitmodules: Git 子模块配置。
• LICENSE: 项目许可证文件。
• README.md: 项目说明文档。
• build.zig: 项目构建配置文件。
• build.zig.zon: 项目构建依赖配置文件。

2. 项目的启动文件介绍

项目的启动文件通常是 examples/basic_example.zig 或 examples/advanced_example.zig。这些文件展示了如何使用 Zig-ECS 库来创建和管理实体组件系统。

示例代码 examples/basic_example.zig

const std = @import("std");
const ecs = @import("../src/ecs.zig");

pub fn main() void {
    var world = ecs.World.init();
    defer world.deinit();

    // 创建实体并添加组件
    const entity = world.createEntity();
    world.addComponent(entity, Position{ .x = 0, .y = 0 });
    world.addComponent(entity, Velocity{ .x = 1, .y = 1 });

    // 更新系统
    world.update();
}

const Position = struct {
    x: f32,
    y: f32,
};

const Velocity = struct {
    x: f32,
    y: f32,
};

3. 项目的配置文件介绍

build.zig

build.zig 文件是 Zig 项目的构建配置文件，定义了如何编译项目。

const std = @import("std");

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

    const exe = b.addExecutable("zig-ecs", "src/main.zig");
    exe.setTarget(target);
    exe.setBuildMode(mode);
    exe.addPackagePath("ecs", "src/ecs.zig");
    exe.install();

    const run_cmd = exe.run();
    run_cmd.step.dependOn(b.getInstallStep());

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

build.zig.zon

build.zig.zon 文件定义了项目的依赖关系。

{
    "dependencies": {
        "zecs": {
            "url": "https://github.com/prime31/zig-ecs/archive/master.tar.gz",
            "hash": "1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef"
        }
    }
}

通过以上配置文件，可以确保项目在不同环境下正确编译和运行。

zig-ecs项目地址:https://gitcode.com/gh_mirrors/zi/zig-ecs