Skip to content

docs: Add comprehensive CODE_WIKI.md for project overview - #19

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

docs: Add comprehensive CODE_WIKI.md for project overview#19
timebug wants to merge 1 commit into
masterfrom
trae/solo-agent-CuHo5t

Conversation

@timebug

Copy link
Copy Markdown
Owner

🎯 Changes

1. 新增 CODE_WIKI.md 文档文件

  • 新增项目概览章节,包含目录结构、技术栈(Python+PyGame 前端与 C99+UCCI 引擎)及构建运行命令。
  • 新增全局架构与数据流向图,可视化展示 Python GUI 与 C 引擎的交互流程(UCCI 管道或 TCP 网络)。
  • 新增前端 GUI 模块详解,逐一说明 common.pychessman.pychessboard.pychessnet.pycchess.py 等 5 个模块的核心功能与数据结构。
  • 新增 C 引擎核心详解,详细讲解 basepositiongenmovesmovesortevaluatesearchhashopenbookucci 等 9 个核心模块的数据表示、走法生成、评估函数、Negascout 搜索、置换表、开局库及 UCCI 协议实现,并给出依赖关系图。
  • 新增关键算法与设计要点章节,总结搜索算法组合(Negascout、α-β 剪枝、迭代加深、静态搜索、置换表、历史启发、MVV/LVA、Zobrist 哈希、时间控制)、16×16 一维数组局面表示的优势、Python↔引擎交互的命令序列、走法合法性两阶段校验等核心设计决策。
  • 新增常见扩展点与调试入口表格,列出调整搜索深度/时间、更换评估权重、扩展开局库、调试 UCCI 通信等 8 类常见开发需求对应的代码位置。
  • 新增参考协议说明,解释 UCCI 引擎通信协议与 FEN 中国象棋局面表示格式的使用规范。

💡 Technical Highlights

  • 全面性: 文档涵盖了项目从概览到核心算法的各个层面,为开发者提供了完整的参考。
  • 可视化: 引入架构图和依赖关系图,帮助开发者直观理解系统结构和数据流向。
  • 实用性: 提供了常见扩展点和调试入口,方便后续的开发和维护工作。
  • 结构化: 清晰的章节划分和详细的模块说明,使得文档易于阅读和查找信息。

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