Shiva 开源项目使用教程

Shiva 开源项目使用教程

shivaModern Cross-Platform C++ Engine with modularity (MIT). Maintains here: https://github.com/KomodoPlatform/antara-gaming-sdk项目地址:https://gitcode.com/gh_mirrors/shi/shiva

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

shiva/
├── bin/
│   └── shiva_server
├── conf/
│   └── config.yaml
├── src/
│   ├── main.cpp
│   ├── utils/
│   └── modules/
├── include/
│   └── shiva/
├── tests/
│   └── test_main.cpp
├── README.md
└── LICENSE

• bin/: 存放编译后的可执行文件。
• conf/: 存放项目的配置文件。
• src/: 存放源代码文件。
  • main.cpp: 项目的主启动文件。
  • utils/: 存放工具类和函数。
  • modules/: 存放项目的各个模块。
• include/: 存放头文件。
• tests/: 存放测试代码。
• README.md: 项目说明文档。
• LICENSE: 项目许可证。

2. 项目的启动文件介绍

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

#include <iostream>
#include "shiva/server.h"

int main() {
    try {
        shiva::Server server;
        server.init();
        server.run();
    } catch (const std::exception& e) {
        std::cerr << "Exception: " << e.what() << std::endl;
        return 1;
    }
    return 0;
}

• shiva::Server 类负责服务器的初始化和运行。
• server.init() 方法用于初始化服务器配置。
• server.run() 方法启动服务器主循环。

3. 项目的配置文件介绍

conf/config.yaml 是项目的配置文件，用于配置服务器的各种参数。以下是该文件的主要内容：

server:
  port: 8080
  host: "0.0.0.0"

database:
  host: "localhost"
  port: 3306
  user: "root"
  password: "password"
  name: "shiva_db"

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

• server: 配置服务器的监听端口和主机地址。
• database: 配置数据库的连接信息。
• logging: 配置日志的级别和输出文件。

以上是 Shiva 开源项目的基本使用教程，希望对您有所帮助。

shivaModern Cross-Platform C++ Engine with modularity (MIT). Maintains here: https://github.com/KomodoPlatform/antara-gaming-sdk项目地址:https://gitcode.com/gh_mirrors/shi/shiva