游戏客户端架构 / 系统课时
组织项目目录
组织项目目录
本课将把单文件工程整理为适合持续扩展的目录结构,明确引擎、游戏、资源、工具和测试各自的职责。完成后,新增模块时可以快速判断文件应放在哪里,并避免构建产物、运行资源和业务代码相互污染。
学习目标
- 设计引擎工程的一级目录及职责边界
- 建立源码、资源、工具、测试与构建产物的隔离规则
- 使用 CMake 子目录映射模块关系
先确定目录边界
目录划分应围绕“谁依赖谁”和“文件是否参与编译”展开。engine 提供通用引擎能力,game 依赖引擎实现具体游戏,assets 保存运行时资源,tools 放置离线工具,tests 验证模块行为,build 只保存生成结果。

engine 与 game 都可以继续采用 include 和 src 分层:公开头文件放入 include,仅模块内部使用的实现和私有头文件放入 src。这样既能控制依赖,也便于 CMake 设置公开与私有包含路径。
建立目录骨架
在项目根目录执行以下命令创建基础结构:
mkdir -p engine/include/engine engine/src
mkdir -p game/src assets tools tests cmake build
touch engine/CMakeLists.txt game/CMakeLists.txt tests/CMakeLists.txt预期结果:
game-engine-basics/
├── assets/
├── build/
├── cmake/
├── engine/
│ ├── CMakeLists.txt
│ ├── include/engine/
│ └── src/
├── game/
│ ├── CMakeLists.txt
│ └── src/
├── tests/
│ └── CMakeLists.txt
└── tools/Windows 用户可以在文件管理器中创建同名目录,或将命令改写为 PowerShell。build 可以由 CMake 自动创建,也可以预先建立,但不应提交其中的生成文件。
用 CMake 映射模块
根 CMakeLists.txt 只负责全局项目设置和模块装配,不直接罗列所有源文件。下面是完整的根级配置:
cmake_minimum_required(VERSION 3.20)
project(GameEngineBasics
VERSION 0.1.0
LANGUAGES CXX
)
enable_testing()
add_subdirectory(engine)
add_subdirectory(game)
add_subdirectory(tests)add_subdirectory 会依次加载三个模块自己的 CMakeLists.txt。具体库、可执行程序和测试目标应在各自目录中定义,这样模块可以独立维护,也能避免根配置不断膨胀。
推荐采用以下依赖方向:game 可以链接 engine,tests 可以链接被测目标,engine 不应反向依赖 game。assets 默认不参与 C++ 编译,应在运行或打包阶段复制;tools 若是独立程序,可以拥有自己的 CMakeLists.txt,但不要与运行时目标混在一起。
配置完成后,可用以下命令验证子目录是否被正确加载:
cmake -S . -B build预期输出:
-- Configuring done
-- Generating done
-- Build files have been written to: <PATH>/build如果某个子目录缺少 CMakeLists.txt,CMake 会在配置阶段直接报错。此时应先补齐对应文件,或暂时移除尚未启用的 add_subdirectory。
保持仓库整洁
构建目录、编译器缓存和 IDE 临时文件不属于源码,应写入 .gitignore。资源目录可以提交原始资源,但大型二进制文件需要结合 Git LFS 或独立资源仓库管理。
build/
out/
.vscode/
.idea/
*.user
*.suo该配置生效后,git status 不再显示匹配的本地生成文件。验证时可先运行一次 CMake,再执行 git status --short,确认构建产物没有进入待提交列表。
本课总结
- 目录结构应同时表达模块职责、依赖方向和文件是否参与编译
- 根 CMake 负责装配,具体目标应下沉到各模块目录
- 构建产物与临时文件必须隔离并通过
.gitignore排除
下一课预告
下一课将继续完善工程骨架,把编译选项、警告级别和平台差异集中到可复用的 CMake 配置中。