Skip to content

docs: 新增 CODE_WIKI.md 完整技术文档 - #18

Open
timebug wants to merge 1 commit into
masterfrom
trae/solo-agent-mncEPY
Open

docs: 新增 CODE_WIKI.md 完整技术文档#18
timebug wants to merge 1 commit into
masterfrom
trae/solo-agent-mncEPY

Conversation

@timebug

Copy link
Copy Markdown
Owner

🎯 Changes

1. 新增 CODE_WIKI.md 文档

  • 新增项目概述章节,介绍 Harmless 中国象棋引擎的核心功能。
  • 新增目录结构说明,梳理 Python 前端与 C 后端引擎的职责划分。
  • 新增架构说明,阐述 Python 前端与 C 后端通过 UCCI 协议通信的客户端-服务器架构模式。
  • 新增核心模块详解,逐一说明 Python 模块(cchess.py, chessboard.py, chessman.py, chessnet.py, common.py)及 C 模块(genmoves.c, evaluate.c, search.c, ucci.c)的功能与关键方法。
  • 新增关键类与函数索引,列出主要方法及核心函数。
  • 新增游戏流程图解,描述完整的五步执行流程。
  • 新增网络对战说明,介绍基于 TCP 端口 62222 的服务端/客户端连接模式及启动参数。
  • 新增构建与运行指南,包含项目编译、本地 AI 对战、网络对战命令及快捷键说明。
  • 新增依赖项说明,明确 Python 2.7.x + Pygame 1.9.x 前端依赖与 gcc + Make 后端编译环境。
  • 新增故障排除与许可证章节,说明 macOS Pygame 安装指引、防火墙端口开放要求及 GPL v3.0 授权协议。

💡 Technical Highlights

  • 系统性文档: 提供 Harmless 中国象棋引擎项目的全面技术说明,便于开发者快速理解和二次开发。
  • 架构清晰: 详细阐述 Python 前端与 C 后端通过 UCCI 协议通信的客户端-服务器架构模式。
  • 模块化说明: 逐一介绍核心模块的功能与关键方法,提升代码可读性与维护性。
  • 实用指南: 包含构建、运行、网络对战及故障排除等实用信息,降低项目上手难度。

Co-authored-by: traeagent <traeagent@users.noreply.github.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant

@timebug