Ant 游戏引擎

英文版 | 中文版

Ant 是由灵犀互娱开发的开源游戏引擎。目前仅公开了代码仓库，尚未正式发布。文档、示例等将在 Wiki 上逐步完善。如有任何问题，请在 Discussions 发帖讨论。Issues 仅用于 Bug 跟踪，请勿在此提问。

更新并初始化第三方库：

git submodule update --init

搭建编译环境

1.1 Windows

1.1.1 MSVC

安装 Visual Studio 2022 17.5 或更高版本，因为依赖对 C11 原子操作的支持，否则编译时会出现 stdatomic.h no such file or directory 错误。

1.1.2 MINGW

下载并安装 msys2
找到 msys2 安装目录，用 mingw64.exe 打开 msys2 的终端
在 msys2 的终端中修改镜像服务器

echo "Server = https://mirrors.tuna.tsinghua.edu.cn/msys2/mingw/i686/" > /etc/pacman.d/mirrorlist.mingw32
echo "Server = https://mirrors.tuna.tsinghua.edu.cn/msys2/mingw/x86_64/" > /etc/pacman.d/mirrorlist.mingw64
echo "Server = https://mirrors.tuna.tsinghua.edu.cn/msys2/msys/\$arch/" > /etc/pacman.d/mirrorlist.msys

将 ming64 的路径添加到环境变量

echo "export MINGW=/mingw64" >> ~/.bash_profile
echo "export PATH=\$MINGW/bin:\$PATH" >> ~/.bash_profile

安装 gcc/ninja

pacman -Syu mingw-w64-x86_64-gcc mingw-w64-x86_64-ninja

1.2 MACOS

安装 Xcode 和 ninja

2.1 通用

2.1.1 编译构建工具 luamake

git clone https://github.com/actboy168/luamake
cd luamake
git submodule update --init
.\compile\install.bat (msvc)
./compile/install.sh (mingw/linux/macos)

编译

编译 runtime

luamake

编译 tools

tools 包含：shaderc, texturec, gltf2ozz，发布模式会快一个数量级（调试模式下的 tools 可以不编译）

luamake -mode release tools

编译选项

luamake [target] -mode [debug/release] #-mode 默认是 debug

运行

运行一个最简单的示例

bin/msvc/debug/ant.exe test/simple/main.lua

启动编辑器

bin/msvc/debug/ant.exe tools/editor/main.lua [projectdir] #例如：test/simple

调试

安装 VSCode；
安装 Lua Debug 插件；
添加调试配置到 .vscode/launch.json

{
    "version": "0.2.0",
    "configurations": [
        {
            "type": "lua",
            "request": "launch",
            "name": "Debug",
            "luaexe": "${workspaceFolder}/bin/msvc/debug/ant.exe",
            "luaVersion": "lua-latest",
            "path": null,
            "cpath": null,
            "console": "integratedTerminal",
            "stopOnEntry": true,
            "outputCapture": [],
            "program": "test/simple/main.lua",
            "arg": []
        }
    ]
}

关于 ant 目录结构

bin：编译结果，exe/dll/lib 等
build：编译的中间结果
clibs：c/c++ 代码
engine：引擎基础支持代码，包括包管理器、启动代码等
pkg：引擎的各个功能包（包与包之间有依赖）
runtime：引擎运行时的不同平台支持
test：测试工程
tools：引擎相关的工具