Rubeus 2D游戏引擎使用教程

1. 项目目录结构及介绍

Rubeus 是一个跨平台的2D游戏引擎，使用C++编写。以下是项目的目录结构及其介绍：

Rubeus/
├── RubeusCore/
│   ├── src/          # 引擎核心代码
│   └── include/      # 引擎头文件
├── docs/             # 项目文档
├── vendor/           # 第三方库
├── cmake_modules/    # CMake模块
├── appveyor.yml      # AppVeyor配置文件
├── .editorconfig     # 编辑器配置文件
├── .gitattributes    # Git属性配置
├── .gitignore        # Git忽略文件配置
├── AUTHORS.md        # 作者列表
├── CMakeLists.txt    # CMake主配置文件
├── CODE_OF_CONDUCT.md # 行为准则
├── CONTRIBUTING.md   # 贡献指南
├── ISSUE_TEMPLATE.md # 问题模板
├── LICENSE.txt       # 许可证文件
├── README.md         # 项目介绍
├── SETUP.md          # 项目设置指南
├── SETUP_LINUX.md    # Linux系统设置指南
└── SETUP_WINDOWS.md  # Windows系统设置指南

主要目录介绍

• RubeusCore/: 包含引擎的核心代码和头文件。
• docs/: 包含项目的文档，如API文档、使用指南等。
• vendor/: 包含项目依赖的第三方库。
• cmake_modules/: 包含CMake的模块文件，用于项目的构建。

2. 项目的启动文件介绍

Rubeus 项目的启动文件是 CMakeLists.txt。这个文件定义了项目的构建过程，包括源文件的编译、链接库的设置等。

CMakeLists.txt 主要内容

cmake_minimum_required(VERSION 3.10)
project(Rubeus)

# 设置C++标准
set(CMAKE_CXX_STANDARD 17)

# 添加源文件目录
add_subdirectory(RubeusCore)

# 添加可执行文件
add_executable(RubeusApp main.cpp)

# 链接库
target_link_libraries(RubeusApp PRIVATE RubeusCore)

启动流程

1. 配置项目: 使用 cmake 命令生成构建文件。
2. 编译项目: 使用 make 或 ninja 编译项目。
3. 运行项目: 执行生成的可执行文件。

3. 项目的配置文件介绍

Rubeus 项目的配置文件主要包括以下几个：

1. .editorconfig

这个文件定义了项目的代码风格，如缩进、换行等。

root = true

[*]
indent_style = space
indent_size = 4
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true

2. .gitattributes

这个文件定义了Git的属性，如文件的换行符处理等。

* text=auto
*.md text eol=lf
*.cpp text eol=lf
*.h text eol=lf

3. .gitignore

这个文件定义了Git忽略的文件和目录。

# 忽略构建目录
build/

# 忽略IDE生成的文件
.vscode/
.idea/

# 忽略可执行文件
RubeusApp

4. CMakeLists.txt

这个文件定义了项目的构建配置，如编译选项、链接库等。

cmake_minimum_required(VERSION 3.10)
project(Rubeus)

# 设置C++标准
set(CMAKE_CXX_STANDARD 17)

# 添加源文件目录
add_subdirectory(RubeusCore)

# 添加可执行文件
add_executable(RubeusApp main.cpp)

# 链接库
target_link_libraries(RubeusApp PRIVATE RubeusCore)

通过这些配置文件，可以确保项目在不同环境下的一致性和可维护性。