游戏客户端架构 / 系统课时
创建 CMake 工程
创建 CMake 工程
本课将从空目录搭建一个最小但完整的 C++ CMake 工程,并完成配置、编译和运行验证。完成后,你会得到一个可重复构建的基础项目,后续可以继续加入引擎模块、游戏模块、资源和测试。
学习目标
- 理解源代码目录与构建目录分离的原因
- 编写可生成可执行程序的最小
CMakeLists.txt - 使用 CMake 完成配置、编译和运行验证
前置检查
开始前需要准备 CMake 3.20 及以上版本,以及支持 C++17 的编译器。Windows 可使用 Visual Studio Build Tools,macOS 可使用 Apple Clang,Linux 可使用 GCC 或 Clang。
执行以下命令确认工具可用:
cmake --version
c++ --version预期输出:
cmake version 3.<VERSION>
c++ (<COMPILER_INFO>) <VERSION>版本号和编译器描述会因操作系统而不同。若 cmake 或 c++ 无法识别,应先完成安装并重新打开终端。
创建最小工程文件
新建 game-engine-basics 目录,并在其中创建 CMakeLists.txt 与 src/main.cpp。根目录只负责描述构建规则,源文件放入 src,避免后续模块增多时文件混杂。
CMakeLists.txt 内容如下:
cmake_minimum_required(VERSION 3.20)
project(GameEngineBasics
VERSION 0.1.0
LANGUAGES CXX
)
add_executable(game_engine
src/main.cpp
)
target_compile_features(game_engine PRIVATE cxx_std_17)这份配置声明了项目名称、语言和最低 CMake 版本,并创建名为 game_engine 的可执行目标。target_compile_features 将 C++17 要求绑定到目标,而不是修改全局编译选项。
src/main.cpp 内容如下:
#include <iostream>
int main() {
// 先验证工程链路可用,后续再替换为引擎启动流程。
std::cout << "Game engine project is ready." << '\n';
return 0;
}配置文件生效后,CMake 会把 src/main.cpp 编译并链接为 game_engine。验证方法是在独立的构建目录中生成并编译目标。
生成、编译并运行
在项目根目录执行以下命令。-S . 指定源代码目录,-B build 指定构建目录,避免生成文件污染源码。
cmake -S . -B build
cmake --build build预期输出:
-- Configuring done
-- Generating done
[100%] Built target game_engine不同生成器的进度格式可能不同,但必须看到配置完成和目标构建成功。随后在 macOS 或 Linux 运行程序:
./build/game_engine预期输出:
Game engine project is ready.Windows 多配置生成器通常使用:
.\build\Debug\game_engine.exe预期输出:
Game engine project is ready.若提示找不到源文件,应检查 src/main.cpp 的路径和大小写;若修改了目标名称,运行路径也要同步调整。重新配置时可以继续复用 build,需要彻底清理时再删除该目录。
本课总结
- CMake 工程至少需要项目声明、构建目标和对应源文件
- 使用独立
build目录可以保持源码整洁并简化清理 - 只有配置、编译和运行都成功,基础工程链路才算验证完成
下一课预告
下一课将把当前最小工程整理为可扩展的目录骨架,明确引擎源码、游戏源码、资源、工具和测试之间的边界。