开源项目 Chinese-Chess 使用教程

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

Chinese-Chess/
├── src/
│   ├── main.py
│   ├── config.py
│   ├── board.py
│   ├── pieces/
│   │   ├── base_piece.py
│   │   ├── king.py
│   │   ├── advisor.py
│   │   ├── elephant.py
│   │   ├── horse.py
│   │   ├── rook.py
│   │   ├── cannon.py
│   │   └── pawn.py
│   └── utils/
│       ├── constants.py
│       └── helpers.py
├── tests/
│   ├── test_board.py
│   ├── test_pieces.py
│   └── test_utils.py
├── docs/
│   ├── README.md
│   └── CONTRIBUTING.md
├── .gitignore
├── LICENSE
└── requirements.txt

目录结构介绍

• src/: 项目的主要源代码目录。
  • main.py: 项目的启动文件。
  • config.py: 项目的配置文件。
  • board.py: 棋盘逻辑文件。
  • pieces/: 棋子相关文件。
    • base_piece.py: 基础棋子类。
    • king.py, advisor.py, elephant.py, horse.py, rook.py, cannon.py, pawn.py: 具体棋子类。
  • utils/: 工具类文件。
    • constants.py: 常量定义。
    • helpers.py: 辅助函数。
• tests/: 测试文件目录。
  • test_board.py, test_pieces.py, test_utils.py: 对应的测试文件。
• docs/: 文档目录。
  • README.md: 项目介绍文档。
  • CONTRIBUTING.md: 贡献指南。
• .gitignore: Git 忽略文件配置。
• LICENSE: 项目许可证。
• requirements.txt: 项目依赖文件。

2. 项目的启动文件介绍

main.py

main.py 是项目的启动文件，负责初始化游戏环境、加载配置、启动游戏主循环等。以下是 main.py 的主要内容：

import config
from board import Board

def main():
    # 加载配置
    game_config = config.load_config()
    
    # 初始化棋盘
    board = Board(game_config)
    
    # 启动游戏主循环
    board.run()

if __name__ == "__main__":
    main()

功能介绍

• 加载配置文件 config.py 中的配置。
• 初始化棋盘对象 Board。
• 启动游戏主循环，开始游戏。

3. 项目的配置文件介绍

config.py

config.py 是项目的配置文件，负责定义和加载游戏的各种配置参数。以下是 config.py 的主要内容：

import json

def load_config():
    with open('config.json', 'r') as f:
        config = json.load(f)
    return config

def save_config(config):
    with open('config.json', 'w') as f:
        json.dump(config, f, indent=4)

功能介绍

• load_config(): 从 config.json 文件中加载配置参数。
• save_config(config): 将配置参数保存到 config.json 文件中。

config.json 示例

{
    "board_size": 9,
    "piece_colors": {
        "red": "#FF0000",
        "black": "#000000"
    },
    "initial_positions": {
        "king": [0, 4],
        "advisor": [0, 3, 5],
        "elephant": [0, 2, 6],
        "horse": [0, 1, 7],
        "ro