PyRoyale 项目使用教程

1. 项目目录结构及介绍

PyRoyale/
├── src/
│   ├── core/
│   │   ├── __init__.py
│   │   ├── game_logic.py
│   │   └── ...
│   ├── utils/
│   │   ├── __init__.py
│   │   ├── helpers.py
│   │   └── ...
│   ├── main.py
│   └── ...
├── config/
│   ├── config.yaml
│   └── ...
├── README.md
├── requirements.txt
└── ...

目录结构说明

• src/: 项目的核心代码目录，包含游戏逻辑、工具函数等。
  • core/: 游戏核心逻辑模块。
  • utils/: 工具函数模块。
  • main.py: 项目的启动文件。
• config/: 配置文件目录，包含项目的配置文件。
• README.md: 项目说明文档。
• requirements.txt: 项目依赖文件。

2. 项目的启动文件介绍

main.py

main.py 是项目的启动文件，负责初始化游戏环境并启动服务器。以下是 main.py 的主要功能：

import os
from src.core.game_logic import GameLogic
from src.utils.helpers import load_config

def main():
    # 加载配置文件
    config = load_config('config/config.yaml')
    
    # 初始化游戏逻辑
    game_logic = GameLogic(config)
    
    # 启动服务器
    game_logic.start_server()

if __name__ == "__main__":
    main()

主要功能

• 加载配置文件: 使用 load_config 函数从 config/config.yaml 文件中加载配置。
• 初始化游戏逻辑: 创建 GameLogic 对象，并传入配置参数。
• 启动服务器: 调用 GameLogic 对象的 start_server 方法启动服务器。

3. 项目的配置文件介绍

config/config.yaml

config.yaml 是项目的配置文件，包含服务器配置、数据库连接信息等。以下是配置文件的示例内容：

server:
  host: "0.0.0.0"
  port: 8080

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

logging:
  level: "INFO"
  file: "pyroyale.log"

配置项说明

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

通过以上配置，项目可以灵活地调整服务器和数据库的设置，以适应不同的部署环境。