OpenGMK 项目使用文档

OpenGMK 项目使用文档

OpenGMKA rewrite of the GameMaker Classic engine runners with additional tooling项目地址:https://gitcode.com/gh_mirrors/op/OpenGMK

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

OpenGMK 项目的目录结构如下：

OpenGMK/
├── docs/
├── src/
│   ├── core/
│   ├── modules/
│   └── main.cpp
├── config/
│   └── config.yaml
├── tests/
├── README.md
└── LICENSE

目录结构介绍

• docs/: 存放项目的文档文件。
• src/: 项目的源代码目录。
  • core/: 核心功能模块。
  • modules/: 其他功能模块。
  • main.cpp: 项目的主启动文件。
• config/: 配置文件目录。
  • config.yaml: 主要的配置文件。
• tests/: 测试代码目录。
• README.md: 项目说明文件。
• LICENSE: 项目的开源许可证。

2. 项目的启动文件介绍

项目的启动文件是 src/main.cpp。该文件负责初始化项目并启动主程序。以下是 main.cpp 的主要内容：

#include "core/init.h"
#include "core/run.h"

int main() {
    // 初始化项目
    init();
    
    // 运行主程序
    run();
    
    return 0;
}

启动文件介绍

• init(): 初始化函数，负责加载配置文件、初始化日志系统等。
• run(): 主运行函数，负责启动项目的核心逻辑。

3. 项目的配置文件介绍

项目的配置文件位于 config/config.yaml。该文件采用 YAML 格式，包含项目运行所需的各种配置参数。

配置文件内容示例

server:
  host: "127.0.0.1"
  port: 8080

database:
  host: "localhost"
  port: 3306
  username: "root"
  password: "password"
  database_name: "opengmk"

logging:
  level: "info"
  file: "logs/app.log"

配置文件介绍

• server: 服务器配置，包括主机地址和端口号。
• database: 数据库配置，包括数据库主机地址、端口号、用户名、密码和数据库名。
• logging: 日志配置，包括日志级别和日志文件路径。

通过以上文档，您可以了解 OpenGMK 项目的目录结构、启动文件和配置文件的基本信息，以便更好地进行项目开发和维护。

OpenGMKA rewrite of the GameMaker Classic engine runners with additional tooling项目地址:https://gitcode.com/gh_mirrors/op/OpenGMK