Skip to content

docs(okww): 大幅压缩文档,合并配置步骤为快速开始#15

Open
1w1w11w1 wants to merge 1 commit into
AUTO-MAS-Project:masterfrom
1w1w11w1:docs/compress-okww
Open

docs(okww): 大幅压缩文档,合并配置步骤为快速开始#15
1w1w11w1 wants to merge 1 commit into
AUTO-MAS-Project:masterfrom
1w1w11w1:docs/compress-okww

Conversation

@1w1w11w1

@1w1w11w1 1w1w11w1 commented Jul 2, 2026

Copy link
Copy Markdown
Contributor

变更

  • 删除冗余的工作原理详解、运行流程详解、日志判定规则表、游戏关闭策略表等内部实现细节
  • 将「前置准备」「配置脚本」「配置 OK-WW」「配置用户」四个模块合并为统一「快速开始」
  • 精简专项适配说明为三行对比表
  • 清空常见问题,新增 ok-ww 3.4.10 日志关键词误判问题的 FAQ
  • 预留截图占位符,后续补充配图

328 行 → 65 行

Summary by Sourcery

简化并重构 AUTO-MAS 的 OK-WW 脚本指南文档,使其更加聚焦于精炼的快速入门流程以及最小化的功能概览。

Documentation:

  • 通过用精简的专用功能概述和对比表替代详细的内部行为说明,对 OK-WW 集成指南进行压缩。
  • 将原先多步骤的配置章节合并为一个统一的快速入门引导,包含分步说明以及用于截图的示意占位符。
  • 将支持任务列表精简为一张紧凑的表格,并将 FAQ 缩减为仅包含一个条目,用于说明 ok-ww 3.4.10 日志关键字误判的问题。
Original summary in English

Summary by Sourcery

Simplify and restructure the OK-WW script guide documentation for AUTO-MAS to focus on a concise quick-start workflow and a minimal feature overview.

Documentation:

  • Condense the OK-WW integration guide by replacing detailed internal behavior explanations with a brief specialization summary and comparison table.
  • Merge the previous multi-step setup sections into a single quick-start walkthrough with step-by-step instructions and illustrative placeholders for screenshots.
  • Shorten the supported task list into a compact table and trim the FAQ to a single entry addressing an ok-ww 3.4.10 log keyword misjudgment issue.

@
docs(okww): 大幅压缩文档,合并配置步骤为快速开始

- 删除冗余的工作原理详解、运行流程、日志判定规则等内容
- 将 前置准备/配置脚本/配置OK-WW/配置用户 合并为统一快速开始
- 清空常见问题,新增 ok-ww 3.4.10 关键词误判问题的 FAQ
@
@sourcery-ai

sourcery-ai Bot commented Jul 2, 2026

Copy link
Copy Markdown

审阅者指南

通过大幅删减内部实现细节,将多个配置章节合并为单一的「快速上手」流程(附截图),简化特殊适配说明,精简支持任务列表,并用一个聚焦于已知日志关键字误判问题的 FAQ 条目替换之前冗长的常见问题解答。

新版 ok-ww 快速上手文档的流程图

flowchart LR
  A[下载OKWW并满足版本要求
OKWW解压至英文路径
AUTO-MAS ≥ v5.3.0-beta.2] --> B[脚本管理 → 新建脚本
选择 ok-ww 脚本]
  B --> C[设置 ok-ww 路径
选择包含 ok-ww.exe 的根目录
MAS 自动匹配子路径]
  C --> D[配置 ok-ww
在 ok-ww 本体中完成配置
返回 MAS 保存]
  D --> E[添加用户
填写账号密码
选择启动任务]
  E --> F[加入调度队列
脚本自动运行]

  D -. 切换配置模式 .-> G[简洁模式
所有用户共用一套配置]
  D -. 切换配置模式 .-> H[详细模式
每个用户独立配置
在用户页点击 ok-ww 配置]
Loading

文件级变更

变更 详情 文件
精简并简化整体 OK-WW 集成文档,使其聚焦于高层使用方式,而非内部实现细节。
  • 移除了关于工作原理、运行时生命周期、日志判定规则以及游戏关闭策略等的长篇章节。
  • 将 OK-WW 介绍缩减为一句话,只保留一个指向上游文档的链接框。
  • 从页面中移除 AutoProxy 生命周期及 MAS–OK-WW 交互内部机制的详细说明。
docs/script-guide/okww.md
将配置指引重组为单一的「快速上手」工作流,并配以可视化辅助内容。
  • 用编号的快速上手列表替代原先分散的准备、脚本配置、OK-WW 配置、用户配置等章节。
  • 引入与 MAS UI 流程一致的分步说明,并为每一步预留截图占位。
  • 在快速上手步骤中内联简明说明脚本路径选择、ok-ww 配置会话以及用户创建等内容。
docs/script-guide/okww.md
将 OK-WW 特殊适配说明简化为紧凑的对比说明,并减少辅助表格。
  • 用一段简短描述替代详细的 MAS–OK-WW 职责列表,概括配置、任务启动、日志以及生命周期管理。
  • 将完整的「通用脚本 vs OK-WW」特性对比表收缩为仅包含参数、日志判定、配置模式三行的精简表。
  • 新增一段简短说明,解释简洁 vs 详细两种配置模式,替代关于配置目录和 UpdateConfigMode 的完整文档。
  • 将支持任务列表精简为仅包含序号、任务名称和简要描述的 8 行表格。
docs/script-guide/okww.md
用一个聚焦于已知日志关键字误判问题的 FAQ 条目替换大段 FAQ 章节。
  • 移除此前关于脚本路径问题、配置缺失、连接问题、更新中断以及其他通用排障的多数 FAQ 条目。
  • 新增 FAQ 条目,解释 ok-ww 3.4.10 日志中包含「错误」字样的消息会导致 MAS 将成功误判为失败。
  • 说明该问题已在 MAS v5.3.1 中修复,并建议如果升级后问题仍存在,可尝试重新创建脚本配置。
docs/script-guide/okww.md

提示与命令

与 Sourcery 交互

  • 触发新的审阅: 在 Pull Request 中评论 @sourcery-ai review
  • 继续讨论: 直接回复 Sourcery 的审阅评论。
  • 从审阅评论生成 GitHub Issue: 回复对应的审阅评论,请求 Sourcery 基于该评论创建 Issue。你也可以直接回复 @sourcery-ai issue,从该评论创建 Issue。
  • 生成 Pull Request 标题: 在 Pull Request 标题任意位置写上 @sourcery-ai,即可随时生成标题。你也可以在 Pull Request 中评论 @sourcery-ai title 以(重新)生成标题。
  • 生成 Pull Request 摘要: 在 Pull Request 正文任意位置写上 @sourcery-ai summary,即可在相应位置生成 PR 摘要。你也可以评论 @sourcery-ai summary,随时(重新)生成摘要。
  • 生成审阅者指南: 在 Pull Request 中评论 @sourcery-ai guide,即可随时(重新)生成审阅者指南。
  • 解决所有 Sourcery 评论: 在 Pull Request 中评论 @sourcery-ai resolve,将所有 Sourcery 评论标记为已解决。适用于你已经处理完所有评论且不想继续看到它们的情况。
  • 撤销所有 Sourcery 审阅: 在 Pull Request 中评论 @sourcery-ai dismiss,撤销所有现有的 Sourcery 审阅。特别适合希望从头开始新一轮审阅的场景——别忘了再次评论 @sourcery-ai review 以触发新审阅!

自定义你的体验

访问你的 控制面板 以:

  • 启用或禁用审阅特性,例如 Sourcery 生成的 Pull Request 摘要、审阅者指南等。
  • 更改审阅语言。
  • 添加、移除或编辑自定义审阅指令。
  • 调整其他审阅设置。

获取帮助

Original review guide in English

Reviewer's Guide

Refactors the ok-ww script guide documentation by aggressively reducing internal implementation details, merging multiple configuration sections into a single Quick Start flow with screenshots, simplifying the special adaptation explanation, trimming the supported task list, and replacing the previous extensive FAQ with a single focused entry on a known log keyword misjudgment issue.

Flow diagram for the new ok-ww Quick Start documentation

flowchart LR
  A[下载OKWW并满足版本要求
OKWW解压至英文路径
AUTO-MAS ≥ v5.3.0-beta.2] --> B[脚本管理 → 新建脚本
选择 ok-ww 脚本]
  B --> C[设置 ok-ww 路径
选择包含 ok-ww.exe 的根目录
MAS 自动匹配子路径]
  C --> D[配置 ok-ww
在 ok-ww 本体中完成配置
返回 MAS 保存]
  D --> E[添加用户
填写账号密码
选择启动任务]
  E --> F[加入调度队列
脚本自动运行]

  D -. 切换配置模式 .-> G[简洁模式
所有用户共用一套配置]
  D -. 切换配置模式 .-> H[详细模式
每个用户独立配置
在用户页点击 ok-ww 配置]
Loading

File-Level Changes

Change Details Files
Condensed and simplified the overall OK-WW integration documentation to focus on high-level usage rather than internal implementation details.
  • Removed long-form sections on working principles, run-time lifecycle, log judgment rules, and game shutdown strategies.
  • Shortened the OK-WW introduction to a single sentence and kept only a link box to upstream documentation.
  • Removed detailed AutoProxy lifecycle explanations and MAS–OK-WW interaction internals from the page.
docs/script-guide/okww.md
Reorganized configuration guidance into a single Quick Start workflow with visual aids.
  • Replaced separate sections (preparation, script configuration, OK-WW configuration, user configuration) with a numbered Quick Start list.
  • Introduced step-by-step instructions that align with the MAS UI flow, including placeholders for screenshots for each step.
  • Inlined concise explanations of script path selection, ok-ww configuration session, and user creation into the Quick Start steps.
docs/script-guide/okww.md
Simplified the OK-WW special adaptation explanation into a compact comparison and reduced auxiliary tables.
  • Replaced a detailed bullet list of MAS–OK-WW responsibilities with a short descriptive sentence about configuration, task startup, logging, and lifecycle management.
  • Collapsed the full "通用脚本 vs OK-WW" feature comparison table into a minimal 3-row table covering parameters, log judgment, and configuration modes.
  • Introduced a short note explaining 简洁 vs 详细 config modes instead of the full configuration directory and UpdateConfigMode documentation.
  • Trimmed the supported task list to a concise 8-row table with only sequence, task name, and short description.
docs/script-guide/okww.md
Replaced the large FAQ section with a single focused FAQ entry addressing a known log keyword misjudgment issue.
  • Removed most previous FAQ entries on script path issues, config missing, connection problems, update interruptions, and other general troubleshooting.
  • Added a new FAQ entry explaining the ok-ww 3.4.10 log message containing "错误" causing MAS to misjudge success as failure.
  • Documented that the issue is fixed in MAS v5.3.1 and suggests recreating script config if the problem persists after upgrade.
docs/script-guide/okww.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey - 我发现了 1 个问题,并且给出了一些高层次的反馈:

  • 在“支持的任务”表格中,第 3 行说明里的“刷取声骸”疑似笔误,建议改为“刷取声骸”以保持术语统一。
  • 快速开始第 1 步同时包含 ok-ww 下载、解压路径要求和 AUTO-MAS 版本约束,建议拆成两个条目(环境前置 vs 下载配置)以提高可读性。
  • 新加入的截图占位路径(/docs/img/script-guide/okww/...)目前是静态写死的,合并前请确认这些资源会在后续 PR 中按路径补齐,以避免构建时出现 404 或断图。
供 AI Agent 使用的 Prompt
请根据本次代码评审中的评论进行修改:

## 总体评论
- 在“支持的任务”表格中,第 3 行说明里的“刷取声骸”疑似笔误,建议改为“刷取声骸”以保持术语统一。
- 快速开始第 1 步同时包含 ok-ww 下载、解压路径要求和 AUTO-MAS 版本约束,建议拆成两个条目(环境前置 vs 下载配置)以提高可读性。
- 新加入的截图占位路径(/docs/img/script-guide/okww/...)目前是静态写死的,合并前请确认这些资源会在后续 PR 中按路径补齐,以避免构建时出现 404 或断图。

## 单条评论

### 评论 1
<location path="docs/script-guide/okww.md" line_range="47" />
<code_context>
-| 代理失败 / 游戏启动失败 / 异常 | ✅ | ✅(干净重试) |
+| 1 | DailyTask | 日常任务 |
+| 2 | MultiAccountDailyTask | 多账号日常 |
+| 3 | FarmEchoTask | 刷取声骸 |
+| 4 | AutoRogueTask | 肉鸽 |
+| 5 | ForgeryTask | 凝素领域 |
</code_context>
<issue_to_address>
**issue (typo):** “刷取声骸”疑为笔误,建议改为“刷取声骸”。

此处在描述任务功能时,“刷取声骸”是更常见、自然的写法,目前的“刷取”应为输入错误。建议修改为“刷取声骸”,以避免歧义。

```suggestion
| 3 | FarmEchoTask | 刷取声骸 |
```
</issue_to_address>

Sourcery 对开源项目免费——如果你觉得我们的评审有帮助,欢迎分享 ✨
帮我变得更有用!请在每条评论下点 👍 或 👎,我会根据你的反馈改进后续评审。
Original comment in English

Hey - I've found 1 issue, and left some high level feedback:

  • 在“支持的任务”表格中,第 3 行说明里的“刷取声骸”疑似笔误,建议改为“刷取声骸”以保持术语统一。
  • 快速开始第 1 步同时包含 ok-ww 下载、解压路径要求和 AUTO-MAS 版本约束,建议拆成两个条目(环境前置 vs 下载配置)以提高可读性。
  • 新加入的截图占位路径(/docs/img/script-guide/okww/...)目前是静态写死的,合并前请确认这些资源会在后续 PR 中按路径补齐,以避免构建时出现 404 或断图。
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- 在“支持的任务”表格中,第 3 行说明里的“刷取声骸”疑似笔误,建议改为“刷取声骸”以保持术语统一。
- 快速开始第 1 步同时包含 ok-ww 下载、解压路径要求和 AUTO-MAS 版本约束,建议拆成两个条目(环境前置 vs 下载配置)以提高可读性。
- 新加入的截图占位路径(/docs/img/script-guide/okww/...)目前是静态写死的,合并前请确认这些资源会在后续 PR 中按路径补齐,以避免构建时出现 404 或断图。

## Individual Comments

### Comment 1
<location path="docs/script-guide/okww.md" line_range="47" />
<code_context>
-| 代理失败 / 游戏启动失败 / 异常 | ✅ | ✅(干净重试) |
+| 1 | DailyTask | 日常任务 |
+| 2 | MultiAccountDailyTask | 多账号日常 |
+| 3 | FarmEchoTask | 刷取声骸 |
+| 4 | AutoRogueTask | 肉鸽 |
+| 5 | ForgeryTask | 凝素领域 |
</code_context>
<issue_to_address>
**issue (typo):** “刷取声骸”疑为笔误,建议改为“刷取声骸”

此处描述任务功能时,“刷取声骸”是更常见、自然的写法,目前的“刷取”应为输入错误。建议修改为“刷取声骸”,以避免歧义。

```suggestion
| 3 | FarmEchoTask | 刷取声骸 |
```
</issue_to_address>

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Comment thread docs/script-guide/okww.md
| 代理失败 / 游戏启动失败 / 异常 | ✅ | ✅(干净重试) |
| 1 | DailyTask | 日常任务 |
| 2 | MultiAccountDailyTask | 多账号日常 |
| 3 | FarmEchoTask | 刷取声骸 |

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

issue (typo): “刷取声骸”疑为笔误,建议改为“刷取声骸”。

此处在描述任务功能时,“刷取声骸”是更常见、自然的写法,目前的“刷取”应为输入错误。建议修改为“刷取声骸”,以避免歧义。

Suggested change
| 3 | FarmEchoTask | 刷取声骸 |
| 3 | FarmEchoTask | 刷取声骸 |
Original comment in English

issue (typo): “刷取声骸”疑为笔误,建议改为“刷取声骸”

此处描述任务功能时,“刷取声骸”是更常见、自然的写法,目前的“刷取”应为输入错误。建议修改为“刷取声骸”,以避免歧义。

Suggested change
| 3 | FarmEchoTask | 刷取声骸 |
| 3 | FarmEchoTask | 刷取声骸 |

Sign up for free to 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