From 41e12394b7cba20260057f6198b03c92a3511365 Mon Sep 17 00:00:00 2001 From: 1w1w11w1 <1252530896@qq.com> Date: Wed, 26 Aug 2026 01:55:54 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20=E7=94=A8=E5=B9=B3=E5=AE=9E=E8=AF=AD?= =?UTF-8?q?=E8=A8=80=E9=87=8D=E5=86=99=E7=94=A8=E6=88=B7=E5=90=91=E6=96=87?= =?UTF-8?q?=E6=A1=A3=EF=BC=8C=E8=A1=A5=E9=BD=90=E8=8B=B1=E6=96=87=E7=BC=BA?= =?UTF-8?q?=E9=A1=B5?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 面向普通用户的页面此前存在几类阅读障碍：内部实现术语（脚本实例任务、 TaskMapping、内部配置键名）直接暴露给用户；调度队列提醒块自相矛盾； 部分句子字面意思与本意相反；同一机制在多处重复解释。 本次改动： - 术语改为用户语言，判定逻辑等长句改为表格 - 章节按用户看到的症状重组，先说为什么在意再说怎么做 - 修正 march7th/sra 中"以便出现不必要的异常"等反义病句 - 修正调度队列"串联运行"与"同时运行所有脚本"的矛盾表述 - 合并 m9a 中重复三遍的配置隔离说明，FAQ 去重 - hsr 移除 PR 编号与内部标识符，改为按实际界面描述 同时修正两处事实错误： - 模拟器权限因果写反，实为已有非管理员实例会阻止新实例以管理员启动 - 配置导出占位符英文文档写作 C:/ScriptRoot，实际代码硬编码为 C:/脚本根目录；并补充此前两边均缺失的 %APPDATA% 脱敏行为与 游戏路径不脱敏的说明 新增英文页面： - en/docs/script-guide/sra.md（修复英文侧边栏既有死链） - en/docs/advanced-features/game-sign.md（并接入英文侧边栏） --- .vitepress/config/en.ts | 1 + docs/FAQ.md | 85 +++--- docs/advanced-features/emulator.md | 56 ++-- docs/advanced-features/game-sign.md | 78 ++++-- docs/advanced-features/index.md | 11 +- docs/advanced-features/mcp.md | 20 +- docs/advanced-features/notification.md | 129 ++++----- docs/script-guide/general.md | 154 ++++++----- docs/script-guide/hsr.md | 311 ++++++++++----------- docs/script-guide/index.md | 33 +-- docs/script-guide/m9a.md | 181 ++++-------- docs/script-guide/maa.md | 29 +- docs/script-guide/maaend.md | 92 ++++--- docs/script-guide/march7th.md | 10 +- docs/script-guide/okww.md | 14 +- docs/script-guide/sra.md | 46 ++-- docs/task-scheduler.md | 62 ++--- docs/user-guide.md | 53 ++-- en/docs/FAQ.md | 91 +++--- en/docs/advanced-features/emulator.md | 56 ++-- en/docs/advanced-features/game-sign.md | 162 +++++++++++ en/docs/advanced-features/index.md | 9 +- en/docs/advanced-features/mcp.md | 24 +- en/docs/advanced-features/notification.md | 131 ++++----- en/docs/script-guide/general.md | 155 ++++++----- en/docs/script-guide/hsr.md | 319 ++++++++++------------ en/docs/script-guide/index.md | 35 +-- en/docs/script-guide/m9a.md | 198 ++++---------- en/docs/script-guide/maa.md | 29 +- en/docs/script-guide/maaend.md | 89 +++--- en/docs/script-guide/march7th.md | 10 +- en/docs/script-guide/okww.md | 14 +- en/docs/script-guide/sra.md | 100 +++++++ en/docs/task-scheduler.md | 61 ++--- en/docs/user-guide.md | 69 ++--- en/index.md | 29 +- index.md | 26 +- 37 files changed, 1493 insertions(+), 1479 deletions(-) create mode 100644 en/docs/advanced-features/game-sign.md create mode 100644 en/docs/script-guide/sra.md diff --git a/.vitepress/config/en.ts b/.vitepress/config/en.ts index e3f273e..fc3e998 100644 --- a/.vitepress/config/en.ts +++ b/.vitepress/config/en.ts @@ -40,6 +40,7 @@ export const enThemeConfig: DefaultTheme.Config = { text: "Advanced Features", link: "/en/docs/advanced-features/", items: [ + { text: "Game Check-in", link: "/en/docs/advanced-features/game-sign" }, { text: "Emulator Management", link: "/en/docs/advanced-features/emulator" }, { text: "Notifications", link: "/en/docs/advanced-features/notification" }, { text: "MCP Service", link: "/en/docs/advanced-features/mcp" }, diff --git a/docs/FAQ.md b/docs/FAQ.md index b51757a..5145edd 100644 --- a/docs/FAQ.md +++ b/docs/FAQ.md @@ -1,8 +1,8 @@ # 常见问题 -更多问题请参考 。 +这里没有的问题，去 翻一下。 -脚本软件问题请阅读脚本文档或咨询脚本开发者 +如果问题出在脚本本身（比如 MAA 识别不出关卡），那是脚本的事，请查该脚本的文档或问脚本作者——AUTO-MAS 只负责调度它们。 ## 疑问解答 @@ -11,89 +11,82 @@ - 代肝用 AUTO-MAS 就是利好代肝，用户用 AUTO-MAS 就是利好用户。 - 而且 AUTO-MAS 的传播范围越广，就越利好用户，所以还不快帮 AUTO-MAS 宣传一波！ -### 我的数据（账号密码）安全吗？ +### 我的账号密码安全吗？ -为了确保您的敏感信息（如登录凭据、访问令牌等）在本地安全存储，我们使用了 **Windows 数据保护 API（DPAPI）**。 +安全。你填的密码、Token 这类东西，是交给 Windows 自带的加密功能（DPAPI）加密后存在本地的，AUTO-MAS 不会把它们传到任何服务器。 -**DPAPI** 是 Windows 提供的一套用于加密和解密敏感数据的本地安全机制，主密钥（Master Key）由用户的登录密码（或系统启动密钥）派生而来，并通过操作系统内核保护，不会明文暴露给应用程序。这意味着： +这套加密和你的 Windows 登录账号绑在一起，所以： - - 只有您本人登录 **Windows 账号** 时，程序才能解密这些数据。 - - 即使他人复制了配置文件，也无法在其他电脑或账户中解密数据。 - - 加解密过程和密钥管理完全由 Windows 系统自动处理，安全且可靠。 +- 只有你本人登录这台电脑的这个 Windows 账号时，程序才解得开。 +- 别人就算把配置文件整个拷走，换台电脑也解不开。 -::: warning 警告 - 在以下情况下，系统可能无法解密原有数据： +::: warning 代价是：换环境就解不开了 +下面三种情况，旧的密码数据会失效，需要你重新填一遍。这不是 bug： - 1. **更换或重装系统** - 如果您重新安装 Windows 或使用新的电脑账户，原账户的加密密钥将丢失，程序将无法读取旧数据。 - 2. **删除或重置用户账户密码** - DPAPI 的加密密钥与您的 Windows 登录凭据绑定。 - 如果您使用非正常方式重置密码（如离线修改、系统修复工具修改等），Windows 无法重新解密旧的加密文件。 - 3. **复制数据到其他电脑或账户** - DPAPI 加密的数据仅在原账户和计算机上有效。复制配置文件到其他环境时，数据会因密钥不匹配而无法解密。 +1. **重装系统，或换了新的 Windows 账户** —— 旧账户的密钥没了。 +2. **用非正常手段重置了 Windows 登录密码**（离线改密、系统修复工具改密等）——正常在系统里改密码没问题，绕过系统改就会丢。 +3. **把配置拷到别的电脑或别的 Windows 账户下用** —— 加密数据只在原来那台电脑的原账户下有效。 ::: ## 故障排查 -### 后端启动失败，跳过后应用内不停报错 Network Error +### 软件一直在报 Network Error -在前端报错页面或打开 `debug/app.log` 查看错误信息。 +这说明后端没起来。先在报错页面上，或者打开 `debug/app.log`，找到具体错误，再对着下面处理： -- **[Errno 10048] error while attempting to bind on address ('0.0.0.0', 36163): 通常每个套接字地址(协议/网络地址/端口)只允许使用一次。** +- **`[Errno 10048] error while attempting to bind on address ('0.0.0.0', 36163)`** - **端口被占用**，AUTO-MAS 后端默认端口为 `36163`，请检查端口是否被占用。 + 端口被别的程序占了。AUTO-MAS 后端用的是 `36163` 端口，查一下是谁占着，把它关掉。 -- **ModuleNotFoundError: No module named 'xxx'** +- **`ModuleNotFoundError: No module named 'xxx'`** - **缺少依赖**，删除软件根目录下 `environment/.requirements_hash` 文件并重启软件，仍无法解决请删除 `environment` 文件夹并重启软件。 + 依赖没装全。删掉安装目录下的 `environment/.requirements_hash` 再重启软件，让它重装一遍。还不行就把整个 `environment` 文件夹删掉重启。 -- **ImportError: DLL load failed while importing onnxruntime_pybind11_state: 动态链接库(DLL)初始化例程失败。** +- **`ImportError: DLL load failed while importing onnxruntime_pybind11_state`** - **缺少系统环境**，AUTO-MAS 运行依赖于 **Microsoft Visual C++** 系统环境，若缺失该环境，您需要手动从 [Microsoft Visual C++](https://learn.microsoft.com/zh-cn/cpp/windows/latest-supported-vc-redist?view=msvc-170#latest-supported-redistributable-version) 或直接从 [Microsoft Visual C++ x64](https://aka.ms/vc14/vc_redist.x64.exe) 中下载并安装。 + 系统缺 **Microsoft Visual C++ 运行库**。装一下就好：[直接下载 x64 版](https://aka.ms/vc14/vc_redist.x64.exe)（或从 [微软官方页面](https://learn.microsoft.com/zh-cn/cpp/windows/latest-supported-vc-redist?view=msvc-170#latest-supported-redistributable-version) 挑版本）。 -::: tip 注意 +::: tip 报错页面和日志里都看不到错误怎么办 -若前端报错页面与日志文件中均为发现报错日志，请以管理员身份运行终端（或 PowerShell、CMD），执行以下命令： +手动跑一次后端，把错误逼出来。以管理员身份打开终端（PowerShell 或 CMD），执行： ```bash cd {AUTO-MAS 根目录} .\environment\python\python.exe main.py ``` -其中 `{AUTO-MAS 根目录}` 需要自行替换为 AUTO-MAS 安装目录位置。 - -此时终端会输出错误日志，请据此进行故障排查。 +`{AUTO-MAS 根目录}` 换成你的实际安装路径。终端里打出来的报错，就是排查线索。 ::: ### 模拟器启动失败 -- AUTO-MAS 启动的所有脚本与应用都将带有 **管理员权限**。由于模拟器多开时，一部分模拟器实例无管理员权限时，无法以管理员权限启动新的模拟器实例，您需要保证当前所有模拟器实例都以管理员权限启动，包括模拟器多开器。具体操作如下： +原因基本都是权限不一致。AUTO-MAS 启动的脚本和模拟器一律带管理员权限，但如果此时已经有模拟器实例是用普通权限开着的，就没法再以管理员权限启动新实例了。所以**只要有一个实例是普通权限开的，后面的多开就会失败**。 - 1. 关闭所有模拟器实例与模拟器多开器。 - 2. 在 AUTO-MAS 重新启动任务，检查能否正常运行，若仍无法运行，尝试重启电脑后直接在 AUTO-MAS 中启动任务。 - 3. 后续使用模拟器或模拟器多开器时，请 **右键 > 以管理员身份运行**。为方便使用，您可以考虑创建对应快捷方式，并 **右键 > 属性 > 快捷方式 > 高级 > 勾选用管理员身份运行**。 +1. 把所有模拟器实例和多开器全部关掉。 +2. 回 AUTO-MAS 重新启动任务。还不行就重启电脑，然后直接从 AUTO-MAS 启动，中间别手动开模拟器。 +3. 以后自己手动开模拟器和多开器时，都要 **右键 > 以管理员身份运行**。嫌麻烦就给它建个快捷方式，**右键 > 属性 > 快捷方式 > 高级 > 勾选"用管理员身份运行"**，之后双击就是管理员权限。 -### 为什么 AUTO-MAS 无法打开 MAA 设置窗口？ +### 点了配置 MAA，但 MAA 窗口没出来 -- 若您在 MAA 中启用了 **启动 MAA 后直接最小化** 与 **最小化时隐藏至托盘**，请您从托盘区找到 MAA 后继续配置。若您认为该操作过于费时，可尝试启用 **静默模式**。 +MAA 大概是躲到托盘里去了。如果你在 MAA 里开了 **启动后直接最小化** 加 **最小化时隐藏至托盘**，就会这样——去右下角托盘区把它点出来继续配。觉得每次都这样太烦，可以改用 **静默模式**。 -### 脚本配置时报错：主程序必须是脚本根目录的子路径 +### 报错"主程序必须是脚本根目录的子路径" -- 请先检查你的 **脚本根目录** 选项是否正确，你必须先设定此值，才能设置主程序路径等路径 +**脚本根目录** 没设或者设错了。这个值是其他路径的基准，必须先把它设对，才能设主程序路径。 -### **如何安全保存 MAA 的设置？** +### MAA 的设置怎么才算保存成功？ -- 请在 AUTO-MAS 中进行 MAA 配置，并在完成配置后点击 **保存配置**。 +从 AUTO-MAS 里点进去配 MAA，配完回到 AUTO-MAS 点 **保存配置**。绕过 AUTO-MAS 直接开 MAA 改的设置，不会被记录。 -### **打开静默模式后模拟器仍未能自动最小化？** +### 开了静默模式，模拟器却没最小化 - - 请检查是否正确填写模拟器老板键，并确认是否存在按键冲突情况。 +检查模拟器 **老板键** 填对了没，以及这个按键有没有被别的软件抢走（快捷键冲突）。 -### **调度队列为何没有自动运行？** +### 调度队列到点了却没自动跑 -- 请确认调度队列的 **定时运行** 已 **开启**，并且 **软件未被意外关闭**，任何睡眠休眠等情况均无法运行AUTO-MAS（见下）。 +两件事挨个查：**定时运行** 的开关是不是真的启用了；软件是不是被关掉了，或者电脑睡眠/休眠了（见下条）。 -### 可以休眠/睡眠运行 AUTO-MAS 吗？ +### 睡眠 / 休眠状态下能跑吗？ -- **不能**，已知的所有脚本都不支持在睡眠/休眠中运行。 \ No newline at end of file +**不能。** 睡眠休眠时程序整个是停住的，目前所有脚本都不支持这么用。要定时跑就得让电脑保持唤醒。 \ No newline at end of file diff --git a/docs/advanced-features/emulator.md b/docs/advanced-features/emulator.md index 7042da2..16ca53a 100644 --- a/docs/advanced-features/emulator.md +++ b/docs/advanced-features/emulator.md @@ -1,49 +1,35 @@ # 模拟器管理 -模拟器管理是MAS的特色功能，用以一劳永逸的解决部分因为模拟器和模拟器适配相关的各种bug +在这里把模拟器登记一次，各个脚本的模拟器相关配置就由 AUTO-MAS 统一填写，不用你一个个脚本手动对。多开、连不上之类的老问题多半就此解决。 -![notification-1](../img/advanced-features/emulator-1.png) - -*图中内容为示例内容，需进行配置才会如此* - -## 搜索模拟器 - -初次进行配置时，可以进行自动搜索和手动搜索，如果你使用自动搜索多开器，点一下就行。 +说白了它就是个多开器：用命令行问模拟器要到实例信息（端口、实例号等），再自动填进各脚本的配置里。 -MAS会自动搜索安装在 **默认安装路径** 下的模拟器。 - -如果你修改了默认地址，就无法找到，需要进行手动添加。 +![notification-1](../img/advanced-features/emulator-1.png) -让我们先解释以下配置 +*图中是示例内容，你需要自己配置* -## 配置解释 +## 添加模拟器 -**模拟器名称**：字面意思，仅存在于MAS中给你看的 +点自动搜索就行——AUTO-MAS 会扫 **默认安装路径**。 -**模拟器类型**：模拟器软件名，如mumu模拟器/雷电模拟器，有下拉框可以选择 +如果你装模拟器时改过安装位置，自动搜索找不到，得手动添加。 -::: tip 最佳实践 +## 各项配置怎么填 -AUTO-MAS 强烈推荐使用mumu12或雷电模拟器，因其拥有良好的性能和截图效果并且多开器适配完善，如果你从零安装模拟器，务必考虑。 +| 配置项 | 填什么 | +| --- | --- | +| **模拟器名称** | 随便起，只在 AUTO-MAS 里显示给你自己看 | +| **模拟器类型** | 从下拉框选你用的是哪款，如 MuMu / 雷电 | +| **模拟器路径** | 选**多开器**的位置，不是模拟器主程序 | +| **最大等待时间** | 等模拟器启动多久。模拟器起来之后才会启动脚本，机器慢就调大 | +| **老板键** | 静默模式下 AUTO-MAS 会自动按这个键把模拟器藏起来 | +::: tip 常见的多开器路径 +- MuMu12 v4：`mumu安装目录\shell\MuMuManager.exe` +- MuMu12 v5：`mumu安装目录\nx_main\MuMuManager.exe` +- 雷电：`雷电安装目录\LDPlayer9\dnplayer.exe` ::: -**模拟器路径**：对应软件的模拟器**多开器**所在目录 - -::: tip 常见模拟器路径 - -mumu12v4：mumu安装目录\shell\MuMuManager.exe - -mumu12v5：mumu安装目录\nx_main\MuMuManager.exe - -雷电模拟器：雷电安装目录\LDPlayer9\dnplayer.exe - +::: tip 还没装模拟器的话，选 MuMu12 或雷电 +这两款性能和截图效果都不错，多开器适配也最完善，AUTO-MAS 对它们的支持最好。用别的模拟器可能会遇到没人踩过的坑。 ::: - -**最大等待时间**：即脚本使用此模拟器时，等待多久模拟器才会启动，模拟器启动后才会启动脚本程序 - -**老板键**：如果使用静默模式，则会自动按下 - -## 碎碎念 - -模拟器管理的本质就是一个多开器，通过一系列的命令行命令来获得模拟器的各项信息，然后自动填入进对应脚本的配置项里。 diff --git a/docs/advanced-features/game-sign.md b/docs/advanced-features/game-sign.md index aeae5c3..3fdd3a8 100644 --- a/docs/advanced-features/game-sign.md +++ b/docs/advanced-features/game-sign.md @@ -1,6 +1,8 @@ # 游戏签到工具 -游戏签到工具用于统一管理多个游戏社区的 Token，并按用户配置执行签到。目前支持 **森空岛、米游社、库街区、塔吉多**。工具会自动读取已绑定的游戏角色，并在签到结果中显示角色、游戏和状态。 +每天挨个打开社区 App 点签到很烦。把凭据填一次进来，之后代理任务顺手就把签到做了。 + +目前支持 **森空岛、米游社、库街区、塔吉多** 四个社区。你不用告诉它你有哪些角色——它会自己读出你号上绑定的游戏角色，逐个签到，然后在结果里列出每个角色的状态。 ::: warning 使用前须知 @@ -24,11 +26,17 @@ ### 三种触发方式 -- **MAS 任务调度签到**：由 MAS 调度任务触发，属于自动签到。自动签到每天每个账号只进行一次尝试，完成后当天不会重复请求。 -- **启动时签到**：应用启动后按配置执行一次，通知单独发送。 -- **手动签到**：点击 **全部签到** 立即执行，不受自动签到当天已执行的限制；手动签到期间如果自动签到正在运行，界面会提示稍后重试。 +| 什么时候签 | 一天签几次 | 通知怎么发 | +| --- | --- | --- | +| **跟着代理任务签** | 每个账号每天只试一次，签过就不再请求 | 并进任务完成通知里 | +| **软件启动时签** | 每次启动执行一次 | 单独发一条 | +| **你自己点 全部签到** | 随时都能点，不受"今天已签过"限制 | 单独发一条 | + +::: tip 点了全部签到却提示稍后重试 +说明自动签到正好在跑，等它结束再点。 +::: -任务调度触发的签到结果会汇总到对应的任务完成通知中；启动时签到和手动签到会单独发送社区签到通知。未配置凭据的社区不会出现在通知中。 +没填凭据的社区不会出现在通知里，不用担心看到一堆空条目。 ## 森空岛 @@ -79,23 +87,29 @@ ## 库街区 -库街区会自动读取绑定的 **战双帕弥什** 和 **鸣潮** 角色，并逐个执行社区签到。 +自动读取你绑定的 **战双帕弥什** 和 **鸣潮** 角色，逐个签到。 ### 获取 Token -库街区当前使用客户端登录凭据中的 Token。可按以下方式获取： +库街区这一家最麻烦：**没有网页端或扫码入口**，Token 得从客户端的本地登录数据里翻出来。具体位置随客户端版本和系统环境变化，这里没法给出一条通用步骤。 -1. 使用库街区客户端登录目标账号。 -2. 按客户端版本和系统环境，从本地登录数据中提取 Token。 -3. 将 Token 粘贴到用户编辑窗口的 **库街区** 输入框并保存。 +1. 先用库街区客户端登录你要签到的账号。 +2. 从本地登录数据中找到 Token。 +3. 粘贴到用户编辑窗口的 **库街区** 输入框，保存。 -也可以参考开源项目 [Kuro_login](https://github.com/mxyooR/Kuro_login) 了解 Token 获取方式。该项目不是 AUTO-MAS 官方项目，使用前请自行审查代码、确认来源，并承担向第三方工具提供登录凭据的风险；AUTO-MAS 不会索要或接收该项目的账号密码。 +第 2 步可以参考开源项目 [Kuro_login](https://github.com/mxyooR/Kuro_login) 的做法。 + +::: warning 这是第三方项目，不是 AUTO-MAS 官方的 +用之前请自己看一遍代码、确认来源可靠。向任何第三方工具提供登录凭据都有风险，需自行承担。AUTO-MAS 不会索要也不会接收该项目的账号密码。 +::: -如果账号没有绑定可签到角色，库街区不会生成可展示的游戏签到条目；Token 失效时会在签到结果中显示失败原因。 +账号没绑定可签到的角色时，结果里不会出现库街区的条目。Token 失效会在结果里写明失败原因。 ## 塔吉多 -塔吉多会自动查询账号的游戏角色并执行社区签到。塔吉多凭据也可以携带云异环凭据，用于查询云异环时长；云异环不是独立的登录入口。 +自动查出你号上的游戏角色并签到。 + +顺带说一句：如果你还想看云异环的剩余时长，那个凭据是**附在塔吉多凭据里一起填的**，不是单独的登录入口，别去找它的入口。 ### 使用账密获取 Token @@ -114,29 +128,35 @@ 如果同时配置云异环，可在 JSON 中加入 `cloudToken`、`cloudUserId` 和可选的 `cloudDeviceId`。凭据刷新后 AUTO-MAS 会在签到流程中更新保存的 Token，不需要每天重新登录。 -## 结果与通知 - -签到结果中的常见状态如下： +## 看懂签到结果 -| 状态 | 含义 | -| --- | --- | -| 成功 | 本次请求完成签到 | -| 已签到 | 今天已经签到过，未重复领取 | -| 失败 | 请求失败、凭据失效或角色信息不可用 | -| 风控 | 社区接口要求额外验证或暂时拒绝请求 | +| 状态 | 意思 | 要做什么 | +| --- | --- | --- | +| 成功 | 这次签到完成了 | 无 | +| 已签到 | 今天早就签过了，没重复领 | 无，正常情况 | +| 失败 | 请求失败、凭据过期，或读不到角色信息 | 重新获取 Token | +| 风控 | 社区那边要求额外验证，或暂时不理你 | 过一阵再试，别连续重试 | -通知会使用社区、游戏和角色名组合展示结果；能获取真实游戏名时优先显示游戏名。不同社区没有配置 Token 时不会生成空的 `0/0` 社区区块。 +结果按"社区 + 游戏 + 角色名"展示。没填 Token 的社区不会占位，不会看到空的 `0/0` 条目。 ## 常见问题 -### 登录失败后仍提示 Token 已保存 +### Token 过期了 / 签到一直失败 + +先确认这个账号还能在官方客户端或网页端正常登录——如果连官方都登不上，就不是 AUTO-MAS 的问题。能登上就重新取一次 Token： -正常情况下，账号密码登录必须先通过上游响应和 Token 完整性校验，失败不会写入配置。如果界面提示异常，请查看脱敏后的错误信息，不要在日志中打印账号、密码、Cookie 或 Token。 +- **米游社**：重新扫码，最省事。 +- **森空岛、塔吉多**：重新打开各自的账密获取窗口。 +- **库街区**：只能重新从客户端里翻。 -### Token 过期或签到失败 +### 某个游戏没出现在结果里 -先确认账号仍能在对应官方客户端或网页端正常登录，再重新获取 Token。米游社优先使用扫码重新获取；森空岛和塔吉多可重新打开各自的账密获取窗口。库街区需要重新从客户端获取 Token。 +签到工具只处理社区接口报上来的**已绑定角色**。确认那个游戏在这个社区账号下真的绑定了，然后重新点一次 **全部签到** 试试。 -### 看不到某个游戏 +### 登录失败了，却提示 Token 已保存 -签到工具只处理社区接口返回的已绑定角色。请确认当前 Token 对应的账号已绑定该游戏，并在保存凭据后重新执行一次手动签到。 +不该出现这种情况——账号密码登录必须先通过校验才会写入配置，失败是不会保存的。如果你真碰到了，看一下界面上的错误信息并反馈给开发者。 + +::: warning 反馈时不要贴出凭据 +错误信息里的账号、密码、Cookie、Token 请自行涂掉再发出来。 +::: diff --git a/docs/advanced-features/index.md b/docs/advanced-features/index.md index 1e6a5ab..9149e6e 100644 --- a/docs/advanced-features/index.md +++ b/docs/advanced-features/index.md @@ -1,15 +1,18 @@ # 进阶功能 -在了解完基础的用法后，您可以根据教程尝试配置一些更高级的功能，从左侧目录中查看。 - -常用的进阶功能包括：[游戏签到工具](./game-sign)、[模拟器管理](./emulator) 和 [推送通知](./notification)。 - +基础用法跑通之后，这些功能能让日子更好过： +- [模拟器管理](./emulator) —— 登记一次模拟器，各脚本的模拟器配置由 AUTO-MAS 统一填。用模拟器的话建议先配这个。 +- [推送通知](./notification) —— 代理完了发消息到你的邮箱或手机。 +- [游戏签到工具](./game-sign) —— 顺手把各游戏社区的每日签到也做了。 +- [MCP 服务](./mcp) —— 让 AI 替你操作 AUTO-MAS。 ## 参考信息 ### 常见日期时间格式符号对照表 +配 [通用调度](/docs/script-guide/general) 时会用到：把日志里的日期时间改写成下面这些符号。 + | 符号 | 表示内容 | 示例 | |----------|-----------------|------------| | `%Y` | 四位数的年份 | 2025 | diff --git a/docs/advanced-features/mcp.md b/docs/advanced-features/mcp.md index 92d86f2..e9f2812 100644 --- a/docs/advanced-features/mcp.md +++ b/docs/advanced-features/mcp.md @@ -1,16 +1,14 @@ # MCP 服务 -利用 MCP 服务，AI 可以调用 AUTO-MAS 提供的各类工具和功能。 +接上 MCP 之后，你可以直接对 AI 说"帮我把今天的号都代理一遍"，由 AI 去调用 AUTO-MAS 完成——几乎所有能在界面上点的操作，AI 都能替你做。 -## 什么是 MCP +MCP（Model Context Protocol）是一套让 AI 调用外部工具的通用接口。你不需要了解它怎么工作，只要把下面的地址填进你的 AI 客户端就行。 -MCP（Model Context Protocol）是一种开放协议，旨在为 AI 模型提供标准化的接口，使其能够连接外部数据源和工具。通过 MCP，AI 可以安全、高效地调用各种功能，而无需关心底层实现细节。 +## 配置 -## 配置 MCP 服务 +只要你的 AI 客户端支持 MCP，填这个地址即可：`http://localhost:36163/mcp` -对于任何支持 SSE 的 MCP 客户端，您只需提供 AUTO-MAS 的 MCP 的网址 `http://localhost:36163/mcp` 即可。 - -此外，常见的 MCP 客户端（Claude Desktop、Cursor 和 Windsurf）支持使用以下配置： +Claude Desktop、Cursor、Windsurf 这类客户端用配置文件的形式填写： ```json { @@ -23,6 +21,10 @@ MCP（Model Context Protocol）是一种开放协议，旨在为 AI 模型提供 ``` -## 使用 MCP 服务 +## 使用 + +配好之后，**保持 AUTO-MAS 开着**，AI 会自动连上，之后直接用自然语言指挥它就行。 -配置完成后，启动 AUTO-MAS 应用，AI 会自动发现并连接到该 MCP 服务，并可以调用 AUTO-MAS 提供的工具，执行几乎所有 AUTO-MAS 支持的任务。 \ No newline at end of file +::: warning AUTO-MAS 没开的话连不上 +这个地址是 AUTO-MAS 自己提供的服务，软件关了服务就没了，AI 会提示连接失败。 +::: \ No newline at end of file diff --git a/docs/advanced-features/notification.md b/docs/advanced-features/notification.md index f3a58d8..c172a0f 100644 --- a/docs/advanced-features/notification.md +++ b/docs/advanced-features/notification.md @@ -1,26 +1,24 @@ # 通知 -AUTO-MAS 提供丰富的 **通知** 功能，您可以配置想要推送的通知内容以及通知推送的渠道。 +代理跑完了、某个号失败了，让 AUTO-MAS 发消息告诉你。支持邮件、Server 酱、企业微信机器人几种渠道。 -## 全局通知 +## 两级通知：全局和用户 -你可以在 **设置 > 通知设置** 中设置全局通知。 - -根据你的推送设置，任何时候都发送通知 +**全局通知** 在 **设置 > 通知设置** 里配，管所有任务。一般配这一个就够了。 ![notification-1](../img/advanced-features/notification-1.png) -## 用户通知 - -你还可以在 **用户配置 > 通知设置** 中设置用户级通知，允许您为每个用户制定单独的通知方案。 +**用户通知** 在 **用户配置 > 通知设置** 里配，可以给某个号单独指定收件人。典型场景：你帮朋友代肝，想让他自己也收到自己那个号的结果。 -> 该通知不会覆盖全局设置，而是在发送全局通知后额外再发一份给指定用户。 +::: tip 用户通知是"额外多发一份"，不是"改收件人" +配了用户通知之后，全局通知照样会发给你，然后再额外发一份给这个用户指定的地址。它不会覆盖全局设置。 +::: ![notification-2](../img/advanced-features/notification-2.png) -## SMTP 邮件推送渠道 +## 邮件推送 -**SMTP** 是一种可靠有效的电子邮件传输协议，AUTO-MAS 使用 **SMTP-SSL** 推送电子邮件通知。 +用邮箱收通知需要填三样：**SMTP 服务器地址**、**发信邮箱**、**授权码**。下面分别说怎么拿到。 ::: tip **AUTO-MAS 私域邮箱已上线** @@ -43,9 +41,9 @@ AUTO-MAS 提供丰富的 **通知** 功能，您可以配置想要推送的通 ### SMTP 服务器地址 -请根据发信邮箱的电子邮件服务提供商选择正确的 SMTP 服务器地址。 +按你的发信邮箱是哪家的，照抄一行： -| 电子邮件服务提供商 | SMTP 服务器地址 | +| 邮箱 | SMTP 服务器地址 | | ------------------- | --------------------- | | **QQ邮箱** | smtp.qq.com | | **163邮箱** | smtp.163.com | @@ -53,11 +51,13 @@ AUTO-MAS 提供丰富的 **通知** 功能，您可以配置想要推送的通 | **Outlook/Hotmail** | smtp-mail.outlook.com | | **Yahoo Mail** | smtp.mail.yahoo.com | -若未找到您使用的电子邮件服务，请访问该邮件服务的帮助中心或搜索其 SMTP 服务器地址。 +表里没有你的邮箱？去它的帮助中心搜"SMTP 服务器地址"。 ### 获取授权码 -**授权码** 是用于替代您的邮箱密码进行第三方客户端登录的一种特殊密码，您需要填写发信邮箱的授权码。常见邮件服务商授权码的一般获取步骤如下： +**授权码不是你的邮箱登录密码**，是邮箱专门发给第三方软件用的一串码，得单独去开。填错这个是配邮件通知最常见的失败原因。 + +各家的开启位置： 1. **QQ 邮箱** @@ -95,54 +95,44 @@ AUTO-MAS 提供丰富的 **通知** 功能，您可以配置想要推送的通 - 找到 **生成应用程序密码** 或类似选项以创建应用密码。 -::: warning 注意 - -- 为了您的信息安全，请勿将授权码告诉他人，并定期更换。 -- 部分邮箱的授权码仅显示一次，请及时保存；部分邮箱的授权码存在有效期，请在到期前及时更换。 -- AUTO-MAS 已对本地授权码数据使用 **Windows DPAPI** 加密，这种加密方式将当前用户的登录凭据作为加密密钥的一部分，这意味着只有同一个用户在同一台计算机上才能解密数据。如果您需要跨设备迁移配置文件，请重新输入授权码。 -- SMTP 邮件推送服务**允许发信邮箱与收信邮箱相同**，若没有多余的电子邮箱，可以填写相同的发信邮箱与收信邮箱地址。 - ::: - -## ServerChan 通知推送渠道 +::: tip 只有一个邮箱也能用 +发信和收信可以填同一个地址，自己发给自己，完全没问题。 +::: -**「Server酱」**，英文名 **「ServerChan」**，是一款 **手机** 与 **服务器/智能设备** 之间的通信工具。它的主要作用是： +::: warning 关于授权码 +- 别告给别人，定期换一次。 +- 有些邮箱的授权码**只显示一次**，拿到就存好；有些有有效期，到期了通知就发不出去，记得换。 +- 授权码在本地是加密存的（和你的 Windows 账号绑定），所以**换电脑或重装系统后，需要重新填一次**。 +::: -- 让服务器、路由器等设备推送消息到手机。 -- 在这里，它用于 **AUTO-MAS 代理成功后推送消息到手机**。 +## Server 酱推送（发到手机） -更多信息请查看： +**Server 酱**（ServerChan）是个把消息转发到手机的中转服务。你在 AUTO-MAS 里填一个它给的 Key，代理结果就会推到你手机上。 -::: warning 注意 -Server酱官方在 2024 年推出了一种新的 App 推送渠道，与原来的 **Server酱·Turbo 版** （SCT）不同，并重新命名为 **Server酱³** -（SC3）。 - -在以下配置中，我们使用 **SCT** 代指 **Server酱·Turbo版**，**SC3** 代指 **Server酱³**。 -::: +::: warning 它有两个版本，别搞混 +Server 酱在 2024 年出了新版，和老版是两套东西： -### SendKey +- **SCT** = Server酱·Turbo 版（老版），支持微信、钉钉、飞书等多种渠道 +- **SC3** = Server酱³（新版），**只支持它自己的 App 推送** -**SendKey** 是 **Server酱** 平台对用户的认证方式。只有 **提供 SendKey**，AUTO-MAS 才能将消息精准推送到您的设备。 +下面的配置项，有些只对其中一个版本有效，看清楚再填。 +::: -SCT -平台获取Key： +### SendKey（必填） -SC3 -平台获取Key： +SendKey 就是 Server 酱认你这个人的凭据，填了它消息才知道往哪推。按你用的版本去对应页面拿，**两个平台选一个就行**： -::: warning 注意 -以上两个平台仅需选择一个即可，请根据您的实际情况选择。 -::: +- SCT 用户： +- SC3 用户： -#### ServerChanChannel 代码 +### 渠道代码（只有 SCT 需要填） -**SC3 仅支持 App 推送**，因此 **仅 SCT 平台可填写 ServerChanChannel 代码**。 - -以下是 **可用消息渠道代码**，您需要填写 **对应的数字代码**。 +想让消息推到微信、钉钉这些地方，填对应的数字代码。**SC3 用户跳过这项**，它只有 App 推送。 | 渠道 | 代码 | | ----------------- | ---- | @@ -157,47 +147,36 @@ SC3 | PushDeer | 18 | | 方糖服务号 | 9 | -::: tip **多个渠道填写格式** -**多个渠道请用 `|` 分隔，格式如下：** - -- ❌ `1 | 0 | 9` +::: tip 填多个渠道时，中间不要加空格 - ✔️ `1|0|9` +- ❌ `1 | 0 | 9` -如果未正确填写，系统将使用 **默认推送渠道**。 +格式错了不会报错，但会静默走默认渠道，你可能以为设置生效了其实没有。 ::: -### Tag 内容 - -该功能是 **SC3 平台的新特性**，仅适用于 **SC3**。 +### Tag（只有 SC3 需要填） -::: tip **Tag 填写格式** -**多个 Tag 请用 `|` 分隔**，格式如下： +给推送消息打标签，方便在 App 里分类。**SCT 用户跳过这项**。 -- ❌ `AUTO-MAS | 代理情况` +::: tip 同样不要加空格 - ✔️ `AUTO-MAS|代理情况` +- ❌ `AUTO-MAS | 代理情况` -若留空或填写不正确，则推送消息时不会携带 Tag 信息。 +留空或填错就是不带标签，不影响推送本身。 ::: -## 企业微信群机器人通知推送渠道 +## 企业微信机器人推送（发到微信） -::: info 提示 -本方法只用在企业微信配置一次，后续可直接在微信中接收消息 +::: info 配一次就好，之后直接在微信里收消息 +虽然要注册企业微信，但只是为了拿一个机器人地址，之后消息会直接进你的微信。 ::: -1. 注册企业账号 - - 在电脑上打开 ，按照指引完成企业账号注册。 - - 注册完成后，用注册时绑定的微信号或手机号登录企业微信客户端。 +1. **注册企业账号**：打开 ，按指引注册，然后用绑定的微信号登录企业微信客户端。 -2. 添加群机器人 - - **电脑端**：进入内部群聊，点击右上角的 **···** 菜单，选择 **添加群机器人**。 - - **手机端**：在内部群聊中，点击右上角的 **···** 菜单，然后选择 **添加群机器人**。 - - 机器人的名称和头像可随意填写 +2. **建一个群，加机器人**：进群聊 → 右上角 **···** → **添加群机器人**。名字头像随便填。手机端电脑端都能操作。 -3. 获取群机器人 Webhook 地址 - - 机器人创建者可在查看机器人信息时获取对应的 Webhook URL。 - - **手机端**：进入群聊，点击右上角的 **···** 菜单，选择 **群机器人**，点击对应机器人后即可看到 Webhook 地址。 - - **电脑端**：在群聊中，右键点击相应机器人，选择 **查看资料**，即可获取 Webhook 地址。 +3. **拿 Webhook 地址**： + - 电脑端：在群里右键机器人 → **查看资料**。 + - 手机端：群聊 → 右上角 **···** → **群机器人** → 点进那个机器人。 -4. 配置推送 - - 将获取的 Webhook URL 填写到 AUTO-MAS 的 **推送企业微信机器人通知** 配置项中，即可实现消息推送。 \ No newline at end of file +4. **填进 AUTO-MAS**：把 Webhook 地址粘贴到 **推送企业微信机器人通知** 里，完成。 \ No newline at end of file diff --git a/docs/script-guide/general.md b/docs/script-guide/general.md index 716880a..0703faf 100644 --- a/docs/script-guide/general.md +++ b/docs/script-guide/general.md @@ -6,145 +6,163 @@ date: 2025-07-16 # 通用调度 -::: warning 观前须知 -通用调度功能有一定的入门门槛，独立完成通用脚本配置，需要您对脚本本身的特性有一定的了解。 +::: tip 先看这里：大多数人不需要从零配 +AUTO-MAS 自带一批现成模板。**新建通用脚本 > 从模板创建**，选好模板，填一个脚本路径就能用。 -若您对需要调度的脚本本体了解不多，可以导入其他用户所写的配置。但请注意，通用调度无法保证能够达到与专项适配后的脚本相同的稳定性，请不要苛责配置的分享者~ - -如果确定要使用，请认真阅读本文档后再进行提问。 +三月七、SRC、zzzOD、M9A 等常见脚本都有成熟模板，先去看看有没有你要的。 ::: -::: tip 提示 +::: warning 从零手配需要你了解那个脚本 +如果模板里没有你的脚本，就得自己填监看规则——这需要你知道那个脚本的日志长什么样、怎么启动。不熟的话，建议先找别人分享的配置导入。 -AUTO-MAS 已经拥有许多模板可供直接套用，你可以通过 **新建通用脚本>从模板创建** 直接配置，只需填入脚本软件路径即可使用 +另外，通用调度的稳定性通常不如专门适配过的脚本，这是机制决定的，别怪分享配置的人~ +::: -目前：三月七，src，zzzOD，M9A 等常见脚本均有成熟的模板可供使用 +## 它是怎么工作的 -若遇到问题，欢迎加用户交流群，与开发者、模板贡献者交流 +看懂这两条，后面出问题你自己就能查。 -::: +### 配置怎么管的：借走、还回 -## 调度原理 +AUTO-MAS 不解析脚本的配置格式，而是**整份保管**：任务开始前，把你保存的那份配置原样复制到脚本目录里；任务结束后，再把脚本原来的配置还回去。 -使用本功能前，您需要了解 **通用调度** 本身的基础工作机制，这能为您后续的故障排查带来许多便利。 +所以每个用户跑的时候都是自己那份配置，且不会污染你在脚本里手动做的设置。 -### 配置管理逻辑 +### 成功失败怎么判的：盯日志 -AUTO-MAS 通过直接保存脚本的配置文件（夹）来实现配置管理，在任务开始前，对应的配置文件将被原样导入脚本的指定位置，任务结束后，会恢复脚本内原有的配置文件。 +AUTO-MAS 看不懂脚本界面，它只盯三样东西：**日志里出现了什么文字**、**日志最后一次更新是几点**、**脚本进程有没有退出**。 -### 脚本监看逻辑 +判定规则取决于你有没有填 **任务成功日志**： -AUTO-MAS 通过 **日志文本信息**、**日志时间戳**、**脚本进程是否结束** 指标判定脚本状态，判定逻辑如下： +| 你填了成功日志 | 你留空了成功日志 | +| --- | --- | +| 日志里出现成功关键词 → **成功** | 脚本自己正常退出，且没出现过异常关键词 → **成功** | +| 脚本退出了但没出现过成功关键词 → **失败** | 脚本退出前出现了异常关键词 → **失败** | -- 成功：若 **任务成功日志** 已被填写，且 **日志文本信息** 中存在任意 **任务成功日志**，则视为任务成功；若 **任务成功日志** 留空，且在 **脚本进程结束** 时，**日志文本信息** 中不存在任意 **任务异常日志**，则视为任务成功。 -- 失败：若最后一条 **日志时间戳** 超出 **自动代理超时限制**，则视为任务因超时失败；若 **任务异常日志** 先于 **任务成功日志** 出现，则视为任务失败；若 **任务成功日志** 已被填写，且在 **脚本进程结束** 时，**日志文本信息** 中不存在任意 **任务成功日志**，则视为任务失败。 +另外两条无论如何都生效： + +- 异常关键词比成功关键词先出现 → **失败** +- 日志超过 **自动代理超时限制** 没有任何更新 → 判定卡死，**超时失败** 以 MAA 为例： ![AUTO工作逻辑](../img/AUTO工作逻辑.png) ## 脚本设置 -为了确认程序需要以何种方式调度通用脚本，用户需要准确完成脚本属性的设置，这直接影响到代理的稳定性。 +这些设置决定了 AUTO-MAS 用什么方式伺候你的脚本，填得准不准直接决定代理稳不稳。 ### 脚本根目录 -- **类型**：文件夹 +选脚本所在的**文件夹**。先填这个，其他路径才能填。 -- **描述**：这是为了方便用户重新定位脚本程序位置而设立的配置项，当脚本程序位置发生变化时，只需要重新设置根目录，其他路径将自动同步更改。 +以后脚本换了位置，你只要改这一项，下面的路径会跟着自动改，不用一个个重选。 ### 脚本路径 -- **类型**：可执行文件 +选脚本的**主程序 exe**，也就是你平时双击启动它的那个文件。 -- **描述**：脚本的主程序，无论是配置脚本还是运行任务都需要双击该文件。 +- **提示"所选路径不在脚本根目录下"**：字面意思，回去检查脚本根目录选对了没。 +- **启动不起来**：路径和启动参数二者之一填错了，去 `debug/AUTO-MAS.log` 看具体报错。 -- **常见问题**： +### 脚本启动参数 - - **程序提示所选路径不在脚本根目录下**：字面意思，请检查脚本根目录设置。 - - **配置脚本或自动代理时无法启动**：自行检查路径与脚本启动参数是否正确，可以在 `debug/AUTO-MAS.log` 中查看具体报错信息。 +**大部分脚本不用填这一项，先留空试试。** -### 脚本启动参数 +有些脚本界面里没有"启动后自动开跑"的选项，只能靠命令行参数实现。这类脚本才需要填。 -- **类型**：由 `|`、`%`和`空格`隔开的若干字符 +**怎么找**：去脚本的官网或文档站，搜 **命令行**、**CLI** 这类章节，把能让它"启动即运行"的参数抄过来。 -- **描述**：本配置项仅用于在启动脚本任务时添加附加命令。部分脚本在 UI 界面中没有 `启动后直接运行` 选项，但能够在通过命令行启动时添加对应附加命令来实现该功能。对于这类脚本，您需要设置本项，保证脚本启动后会自动运行任务。 +如果你的脚本还有下面这两种特殊情况，才需要用到分隔符： -- **设置方法**：查阅脚本软件的对应 **官网/文档站**，找到 **cli运行**、**命令行启动** 或其他类似篇章，获取相关信息后填入，保证使用填入的脚本启动参数时，脚本能够在启动后自动运行任务。若运行脚本任务时使用的附加命令与配置脚本时使用的附加命令不相同，可以将二者同时输入到本配置项，中间以 `|` 分隔。若运行脚本任务时使用的可执行文件与配置脚本时使用的可执行文件不相同，可以在对应的附加命令前输入可执行文件相对于 `脚本路径` 的位置，中间以 `%` 分隔。 +- **配置时和跑任务时参数不一样** → 两组参数用 `|` 隔开，前面是跑任务的，后面是配置用的。 +- **配置时和跑任务时用的不是同一个 exe** → 在参数前面写上那个 exe 相对 `脚本路径` 的位置，用 `%` 隔开。 -- **格式**：`{自动代理可执行文件相对于脚本路径的位置}%{自动代理任务附加命令}|{设置具体配置可执行文件相对于脚本路径的位置}%{设置具体配置任务附加命令}` +完整格式长这样（用不到的部分不用写）： -### 追踪脚本子进程 +```text +{跑任务的exe}%{跑任务的参数}|{配置用的exe}%{配置用的参数} +``` -- **类型**：开关 +### 追踪脚本子进程 -- **描述**：用于确认判定 **脚本进程是否结束** 时，是否要考虑脚本的子进程。部分脚本需要通过 **启动器** 打开脚本主程序，脚本主程序启动后，脚本启动器会自动退出，此时不能仅通过 **启动器** 进程是否仍在运行判定整个脚本是否仍在运行。对于此类脚本，需要打开本项。 +**先保持默认，出问题了再动它。** -- **常见问题**： +有些脚本是"启动器拉起主程序，然后启动器自己退出"。这时候光看启动器进程会误判成脚本已经结束了，需要打开这个开关，连子进程一起盯。 - - **手动关闭脚本后，程序未能识别到脚本已关闭**：尝试关闭本项。 - - **脚本仍在运行时，程序错误报告脚本已经退出**：尝试打开本项。 +- **脚本关了，AUTO-MAS 还以为在跑** → 关掉本项。 +- **脚本还在跑，AUTO-MAS 说它退出了** → 打开本项。 ### 脚本配置文件路径 -- **类型**：任意文件/文件夹 - -- **描述**：脚本用于存放配置信息的文件/文件夹。 +选脚本存配置的文件或文件夹。 -- **设置方法**：打开脚本所在目录，通常会存在一个名为 `config` 的文件/文件夹，此文件/文件夹大概率就是 **脚本配置文件**。 +**怎么找**：打开脚本目录，找名字带 `config` 的文件或文件夹，通常就是它。 ### 脚本日志文件路径 -- **类型**：任意文件 +选脚本写日志的那个文件。 -- **描述**：脚本用于存放日志信息的文件。 +**怎么找**：打开脚本目录，先看有没有 `debug`、`log` 之类的文件夹。 -- **设置方法**：打开脚本所在目录，检查是否存在名为 `debug`、`log` 或类似名称的文件夹： - - 若存在，进入该文件夹，检查是否有文件名中不存在日期信息的文件，如：`log.txt`、`gui.log`： - - 若存在，则选择对应文件， - - 若不存在，则选择任意保存有日志信息的文件，这些文件通常具有 `.log`、`.txt` 后缀名，然后设置 **脚本日志文件名格式**。 - - 若不存在，检查脚本根目录是否存在 `.txt`、`.log` 后缀文件，若有，打开确认其内容为脚本日志后，选择该文件。 +- **有这个文件夹**：进去挑一个 `.log` 或 `.txt` 文件。 + - 文件名里**不带日期**（如 `log.txt`、`gui.log`）→ 直接选它，收工。 + - 文件名里**带日期**（如 `2025-06-29.log`）→ 也选它，然后还要填下面的 **日志文件名格式**。 +- **没有这个文件夹**：在脚本根目录里找 `.txt`、`.log` 文件，打开确认里面是日志内容，选它。 ### 脚本日志文件名格式 -- **类型**：用于指示日期时间格式的文本 +**日志文件名里不带日期的，这项留空。** -- **描述**：用于指示实时生成日志文件名的格式。部分脚本软件不会将实时日志写入到一个固定的文件中，而是按照日期，将日志写入不同的文件中。对于此类脚本，用户需要设置日志文件名的格式，以便程序找到实际日志文件位置。 +有些脚本每天新建一个日志文件，文件名带日期，AUTO-MAS 得知道命名规律才能找到今天那份。 -- **设置方法**：复制任意脚本日志文件名到本项中，然后参照 [常见日期时间格式符号对照表](/docs/advanced-features/#常见日期时间格式符号对照表) 将文件名中代表日期与时间的元素替换为对应符号，如：`2019-05-01` -> `%Y-%m-%d`。 +**怎么填**：把一个日志文件名复制进来，然后把里面表示日期时间的部分换成符号。比如 `2019-05-01` 写成 `%Y-%m-%d`。符号含义见 [日期时间格式符号表](/docs/advanced-features/#常见日期时间格式符号对照表)。 ### 脚本日志时间戳起始/结束位置 -- **类型**：数值 +告诉 AUTO-MAS 每行日志里的时间戳从第几个字符开始、到第几个结束——它靠这个判断脚本是不是卡住不动了。 -- **描述**：用于定位日志文件中每一行日志时间戳的起始与结束位置，便于程序识别时间戳。 +**怎么数**：挑一行带时间戳的日志，从 `1` 开始数字符。例如： -- **设置方法**：找到任意一行带有时间戳的日志，从 `1` 开始数，数到时间戳的起始位，此时所数的数值即为起始值，继续数到时间戳结束位，此时所数的数值即为结束值。如：`[2025-06-29 20:00:35.909][INF] <1><> 开始任务`，起始值为 `2`，结束值为 `24`。 +```text +[2025-06-29 20:00:35.909][INF] <1><> 开始任务 +``` -### 脚本日志时间格式 +`[` 是第 1 位，时间戳从第 2 位开始，到第 24 位结束。所以起始填 `2`，结束填 `24`。 -- **类型**：用于指示日期时间格式的文本 +### 脚本日志时间格式 -- **描述**：用于指示日志时间戳的格式，方便程序解析时间戳。 +把上面那段时间戳的写法翻译成符号，AUTO-MAS 才读得懂它是几点。 -- **设置方法**：复制任意脚本日志时间戳到本项中，然后参照 [常见日期时间格式符号对照表](/docs/advanced-features/#常见日期时间格式符号对照表) 将文件名中代表日期与时间的元素替换为对应符号，如：`2019-05-01 16:00:00.000` -> `%Y-%m-%d %H:%M:%S.%f`。 +比如 `2019-05-01 16:00:00.000` 填成 `%Y-%m-%d %H:%M:%S.%f`。符号含义见 [日期时间格式符号表](/docs/advanced-features/#常见日期时间格式符号对照表)。 ### 脚本成功/失败日志 -- **类型**：由 `|` 隔开的若干文本 +填关键词，AUTO-MAS 在日志里看到就判成功或失败。可以填多条，用 `|` 隔开。 + +**怎么找**：手动跑一次脚本，打开它的日志文件，找到跑完时打的那句话（比如"任务全部完成"），把里面稳定不变的一小段抄进 **成功日志**；同理把报错时的特征句抄进 **失败日志**。 + +挑词的时候选那种"只在成功时出现"的句子，别挑每次都会打的通用信息，否则会误判。 -- **描述**：用于判断脚本运行状态的参考信息，允许设置多条，不同条目以 `|` 分隔。 +## 分享和导入配置 -- **设置方法**：结合自身使用体验与脚本日志文件内容，发挥主观能动性进行定制~ +好不容易配好一个脚本，可以导出成 JSON 文件分享给别人；别人分享的 JSON 也可以直接导入。想让更多人用上，还能提交到 **AUTO-MAS 配置分享中心**，审核通过后所有用户都能一键导入你的配置。 -## 配置管理 +::: warning 分享前自己检查一遍路径 +导出和上传都会自动做一次脱敏，但**只覆盖一部分路径**，剩下的要你自己看。 -考虑到通用调度功能有一定的入门门槛，为方便用户快速完成通用脚本设置，通用脚本支持快速导入导出配置。您可以导出配置到 `JSON 文件` 并分享给其他用户，也可以导入其他用户分享的 `JSON 文件`。您甚至可以将您的配置上传到 `「AUTO-MAS 配置分享中心」`，通过审核后即可供所有使用本软件的用户一键导入。 +自动处理的： -::: warning 注意 -- 为防止隐私泄露，脚本根目录将被统一替换为 `C:/脚本根目录`，用户导入配置后须自行重新选择。 -- `游戏/模拟器路径` 并不会被统一替换，请自己检查路径中是否可能泄漏个人隐私。 - ::: +- **脚本根目录** 被替换成 `C:/脚本根目录`。所以**导入别人的配置后，第一件事是重新选一次自己的脚本根目录**。 +- **脚本路径、配置文件路径、日志文件路径、追踪进程路径** 这四项，如果在脚本根目录底下，会跟着改成相对根目录的写法；如果在 `AppData` 底下（比如 SRA 的配置目录），会被改写成 `%APPDATA%/...`，你的 Windows 用户名不会漏出去。 + +需要你自己检查的： + +- **游戏/模拟器路径不会被脱敏**，原样保留。 +- 上面那四项如果既不在脚本根目录、也不在 `AppData` 底下，同样原样保留。 + +所以分享前打开导出的 JSON 扫一眼，看到 `C:/Users/张三/...` 这种带真实姓名的路径，自己改掉再发。 +::: ## 下属用户 -**下属用户** 与 MAA 脚本中的 **下属用户** 作用相同，每个子配置的运行机制与 MAA 用户配置的详细模式运行机制类似，每个子配置都需要单独进行设置，设置方法与 MAA 配置方法相同。 +一个通用脚本下面可以挂多个用户，每个用户存一份独立的脚本配置，跑任务时轮流换上。用法和 MAA 脚本的用户一样，每个用户都要单独配一次。 diff --git a/docs/script-guide/hsr.md b/docs/script-guide/hsr.md index 57c3581..60aff7f 100644 --- a/docs/script-guide/hsr.md +++ b/docs/script-guide/hsr.md @@ -4,30 +4,28 @@ description: 在 AUTO-MAS 中调度崩坏：星穹铁道外部脚本（M7A / SRA date: 2026-06-17 --- -# HSR 星穹铁道专项用户指南 +# HSR 星穹铁道配置方法 -::: tip 本页适用范围 -HSR 专项用于在 AUTO-MAS 中调度崩坏：星穹铁道相关外部脚本。当前随 [AUTO-MAS PR #249](https://github.com/AUTO-MAS-Project/AUTO-MAS/pull/249) 引入，对应 AUTO-MAS 内脚本类型 **HSR**。 -::: - -## 什么是 HSR 专项？ +## HSR 专项是什么 -HSR 专项是 AUTO-MAS 内置的一类脚本适配，同时挂接两款主流的星穹铁道 PC 端第三方工具： +星穹铁道有两款常用的第三方脚本，各有所长： -- **三月七小助手（March7th Assistant，M7A）**：M7A 路线，擅长体力脚本与周常执行。 -- **StarRailAssistant（SRA）**：SRA 路线，擅长日常奖励领取、差分宇宙等任务。 +- **三月七小助手（M7A）**：体力副本和周常跑得好。 +- **StarRailAssistant（SRA）**：日常奖励领取、差分宇宙跑得好。 -通过 HSR 专项，AUTO-MAS 可以在一份脚本下混合使用两款引擎，并自动管理游戏启动、脚本调用、失败补跑与周常/月常进度。 +HSR 专项的意义就在这儿：**你不用二选一**。在一个脚本里同时挂上两款，哪个任务交给哪个，由你决定。AUTO-MAS 负责启动游戏、按顺序调用脚本、失败了重跑，以及记住周常月常这周做没做过。 -**支持覆盖的玩法**（以你使用的脚本版本为准）： +**能跑的内容**（具体以你装的脚本版本为准）： - 体力副本：拟造花萼（金）、拟造花萼（赤）、侵蚀隧洞、饰品提取 -- 历战余响（按周重置） -- 日常与奖励（兑换码、邮件、委托、勋礼、每日实训等） -- 周常：差分宇宙（PVE 玩法）、货币战争（PVP 玩法） +- 历战余响（每周重置） +- 日常与奖励：兑换码、邮件、委托、勋礼、每日实训等 +- 周常：差分宇宙、货币战争 - 月常：三深渊（混沌回忆 / 虚构叙事 / 末日幻影） -> ⚠️ **关于三深渊**：AUTO-MAS 已预留三深渊配置入口与快照导入能力，但 PR #249 阶段在用户页将三深渊开关临时禁用，并标注「前面的功能，以后再来探索吧~」。是否可用、稳定性如何，请以你当前 AUTO-MAS 版本的实际界面为准，**不建议将其作为稳定功能使用**。 +::: warning 三深渊暂时用不了 +三深渊的配置入口已经做好了，但当前版本在界面上把开关禁用了，还没经过充分测试。以你软件里的实际界面为准，**先别指望这个功能**。 +::: **详情信息请查阅**： @@ -40,249 +38,214 @@ HSR 专项是 AUTO-MAS 内置的一类脚本适配，同时挂接两款主流的 ## 准备工作 -在 AUTO-MAS 中创建第一个 HSR 脚本前，请完成以下准备： +动手之前先把这几件事做完，能省掉后面一半的坑。 -1. **安装 AUTO-MAS**：使用包含 HSR 专项的版本（即合并 PR #249 之后的版本）。 -2. **安装三月七小助手（M7A）**：解压后请**至少手动打开一次**，等待其完成初始化（首次启动会创建 `config.yaml` 等配置文件）。确认目录下存在 `March7th Assistant.exe`。 -3. **安装 StarRailAssistant（SRA）**：解压后请**至少手动打开一次**，让 SRA 生成 `settings.json`、`configs` 等目录。确认目录下存在 `SRA-cli.exe`。 -4. **安装星穹铁道 PC 端**：国服官方客户端即可，确认目录下存在 `StarRail.exe`。 -5. **杀软/Defender 信任**：将 AUTO-MAS、M7A、SRA、星穹铁道游戏目录加入 Windows Defender 或第三方杀软的信任区，避免外部脚本被拦截导致执行失败。 -6. **避免中文路径**：上述所有目录建议放在纯英文路径下，例如 `D:\AUTO-MAS`、`D:\M7A`、`D:\SRA`、`D:\StarRail`。中文路径与空格路径历史上容易引发图像识别与路径解析问题。 +1. **装好你要用的脚本**（M7A 和 SRA 至少装一个，两个都装才能混用）。 +2. **每个脚本都手动打开一次，等它跑完初始化。** 这步千万别跳——脚本第一次启动才会生成配置文件，AUTO-MAS 要读这些文件才知道有哪些副本可选。跳过这步，后面副本下拉框就是空的。 +3. **装好星穹铁道 PC 端**，国服官方客户端。 +4. **全部加进杀软白名单**：AUTO-MAS、M7A、SRA、游戏这四个目录都要加，不然脚本会被拦下来，任务莫名失败。 +5. **路径别用中文和空格**，例如 `D:\M7A`、`D:\SRA`。中文路径历来容易引发图像识别和路径解析问题。 -::: warning 温馨提醒 -AUTO-MAS 会在保存路径时自动校验所选目录里是否包含期望的 `exe`： +::: warning 路径要选文件夹，不是选 exe +保存时 AUTO-MAS 会检查你选的文件夹里有没有对应的 exe，选错会直接弹窗拦下来： -- 三月七路径：必须包含 `March7th Assistant.exe` -- SRA 路径：必须包含 `SRA-cli.exe` -- 游戏路径：必须包含 `StarRail.exe` - -选错目录会被前端弹窗拦截并要求重选。 +| 填这个 | 文件夹里得有 | +| --- | --- | +| 三月七路径 | `March7th Assistant.exe` | +| SRA 路径 | `SRA-cli.exe` | +| 游戏路径 | `StarRail.exe` | ::: ## 创建 HSR 脚本 ### 1. 新建脚本 -1. 进入 **脚本管理** 页面。 -2. 单击 **新建脚本**。 -3. 在弹出的脚本类型列表中选择 **HSR 脚本**（类型标识：HSR）。 -4. 单击确定，AUTO-MAS 会创建一个 HSR 脚本实例并跳转到脚本配置页。 +进入 **脚本管理** → **新建脚本** → 选择 **HSR 脚本** → 确定。软件会跳到脚本配置页。 -### 2. 配置脚本基本信息 +### 2. 填路径和基本信息 -在 **HSR 脚本配置** 页填写： +| 配置项 | 填什么 | +|---|---| +| **脚本名称** | 随便起个你认得出的名字，比如「主号星穹」 | +| **三月七路径** | M7A 所在**文件夹** | +| **SRA 路径** | SRA 所在**文件夹** | +| **游戏路径** | 星穹铁道所在**文件夹** | +| **游戏最大启动等待时间** | 启动游戏后等几秒再开始操作，默认 60 秒。机器慢就往上调 | +| **游戏启动参数** | 留空 | -| 配置项 | 说明 | 备注 | -|---|---|---| -| **脚本名称** | 给此脚本实例起一个易识别的名称 | 例如「主号星穹」「官服日常」 | -| **三月七路径** | M7A 安装目录（含 `March7th Assistant.exe`） | 校验 exe；可一键清空 | -| **SRA 路径** | SRA 安装目录（含 `SRA-cli.exe`） | 校验 exe；可一键清空 | -| **游戏路径** | 星穹铁道安装目录（含 `StarRail.exe`） | 校验 exe | -| **游戏最大启动等待时间** | AUTO-MAS 启动游戏后等待客户端可操作的秒数 | 默认 60 秒，可按机器性能调高 | -| **游戏启动参数** | 启动 `StarRail.exe` 时附加的命令行参数 | 一般留空 | - -::: tip 小贴士 -- M7A / SRA 两个路径至少要填一个，另一个留空也允许；留空那一侧在「模块脚本分配」中不会出现。 -- 修改完任意路径，模块脚本分配（TaskMapping）会自动按当前已配置路径重新洗牌。 +::: tip 只装了一个脚本也能用 +M7A 和 SRA 填一个就行，另一个留空。留空的那个不会出现在下面的任务分配里。 + +改了路径之后，任务分配会按当前填了哪些路径自动重排一次，回去确认一下。 ::: -### 3. 配置执行限制 +### 3. 设置重试和超时 + +这几项决定"跑多久算卡死"和"失败了重试几次"，默认值适用于大多数人，机器慢可以往上调。 | 配置项 | 说明 | 默认值 | |---|---|---| -| **失败任务最大尝试次数** | 任务失败时自动重试的上限 | 3 | -| **日常任务超时限制（分钟）** | 日常 / 体力 / 奖励类任务单次最大耗时 | 20 | -| **周常任务超时限制（分钟）** | 差分宇宙 / 货币战争等周常任务单次最大耗时 | 60 | -| **月常任务超时限制（分钟）** | 三深渊等月常任务单次最大耗时 | 60 | -| **启用低性能兼容模式** | 仅对三月七差分宇宙生效（映射到 `weekly_divergent_stable_mode`） | 关闭 | +| **失败任务最大尝试次数** | 一个任务失败后最多再试几次 | 3 | +| **日常任务超时限制（分钟）** | 日常 / 体力 / 奖励类任务最多跑多久 | 20 | +| **周常任务超时限制（分钟）** | 差分宇宙 / 货币战争最多跑多久 | 60 | +| **月常任务超时限制（分钟）** | 三深渊最多跑多久 | 60 | +| **启用低性能兼容模式** | 只影响 M7A 跑差分宇宙。M7A 差分跑得不稳就打开 | 关闭 | -### 4. 模块脚本分配（TaskMapping） +### 4. 决定哪个任务交给哪个脚本 -HSR 专项支持把四个模块分别交给 M7A 或 SRA 执行： +这是 HSR 专项的核心：四类任务各自选一个脚本来执行。 -| 模块 | 含义 | 默认引擎 | +| 模块 | 包含什么 | 默认 | |---|---|---| -| **体力** | 开拓力刷取、历战余响等 | SRA | +| **体力** | 开拓力刷副本、历战余响 | SRA | | **日常与奖励** | 兑换码、邮件、委托、勋礼、每日实训等 | SRA | -| **差分宇宙** | 差分宇宙 PVE 玩法 | SRA | -| **货币战争** | 货币战争 PVP 玩法 | SRA | +| **差分宇宙** | 差分宇宙 | SRA | +| **货币战争** | 货币战争 | SRA | -> TaskMapping 实际选项会随你已配置的 M7A / SRA 路径动态变化：两个路径都填了才能二选一；只填一个则只能选那一个。 +只填了一个脚本路径时，这里就只有那一个可选；两个都填了才能自由挑。 -选择不同引擎时，下方「周常任务执行策略」区会显示对应引擎的具体执行参数，**用户页不再需要填写这些参数**： +选完之后，下方会显示该脚本跑这个任务时用的具体策略。**这些策略是固定的，不用你填，用户页也不用再设一遍**： - **差分宇宙** - - SRA：差分宇宙乐园漫记 / 模式刷第一关 / 次数 20 / 启用积分奖励 - - 三月七：启用积分奖励 / 周期演算 / 低性能兼容（跟随脚本页开关）；球队 / 赐福 / 演算策略由 M7A 客户端自行决定 + - SRA：乐园漫记 / 刷第一关 / 20 次 / 领积分奖励 + - M7A：领积分奖励 / 周期演算 / 是否开低性能兼容跟随上面的开关；球队、赐福、演算策略由 M7A 自己决定 - **货币战争** - - SRA：标准博弈 / 最低难度 / SRA 保存的第一套攻略 / 运行次数 2 - - 三月七：启用积分奖励 / 标准博弈 / 最低职级 / 阿格莱雅策略 / 特定词条接受重开 + - SRA：标准博弈 / 最低难度 / 用 SRA 里存的第一套攻略 / 跑 2 次 + - M7A：领积分奖励 / 标准博弈 / 最低职级 / 阿格莱雅策略 / 遇到特定词条会重开 -::: warning SRA 货币战争特别说明 -SRA 在执行完货币战争后，**不会自动领取积分奖励**，请在游戏内手动领取。其他引擎会按其客户端规则自动处理。 +::: warning 用 SRA 跑货币战争，记得自己领奖励 +SRA 跑完货币战争**不会自动领积分奖励**，得你自己进游戏领。换成 M7A 就没这问题。 ::: ## 创建 HSR 用户 -在 HSR 脚本下添加用户： - -1. 在 **脚本管理** 表格内，单击 **添加用户**，或直接进入已创建的 HSR 脚本点击「添加用户」。 -2. 填写 **基本信息**： +在 **脚本管理** 表格里点 **添加用户**，然后填基本信息： -| 字段 | 说明 | +| 字段 | 填什么 | |---|---| -| **用户名** | 用户显示名称；同时会作为货币战争的「开拓者名称」写入 M7A / SRA | -| **启用** | 是否参与自动代理；关闭后该用户会被跳过 | -| **账号** | 登录账号（如手机号），仅在需要自动登录/切号时使用 | -| **密码** | 登录密码，仅在需要自动登录/切号时使用 | -| **服务器** | 当前仅支持「官服（CN-Official）」 | -| **剩余天数** | 剩余有效代理天数；`-1` 表示不限制，0 表示今日到期，正数为剩余天数 | -| **备注** | 自由备注信息 | - -::: warning 账号与密码安全 -- 账号、密码保存在本地，保存时由 AUTO-MAS 自动加密。 -- **没有配置 SRA 路径，或者 TaskMapping 没有把模块交给 SRA 时，账号密码不会用于切号**，仅作为预留字段。 -- **请勿公开分享你的 `data/` 目录或脚本配置 JSON 文件**，其中包含加密凭据。 -::: +| **用户名** | 显示名称。跑货币战争时会作为「开拓者名称」写给脚本 | +| **启用** | 关掉的用户会被跳过 | +| **账号** | 手机号等登录账号，只在需要自动切号时才要填 | +| **密码** | 登录密码，同上 | +| **服务器** | 目前只有官服 | +| **剩余天数** | 还能代理几天。`-1` 是不限制，跑一次减一天，减到 0 就跳过这个用户 | +| **备注** | 随便写 | + +::: warning 关于账号密码 +账号密码保存在本地并自动加密，不会上传。 -### 任务开关 +**没填 SRA 路径，或者没把任务交给 SRA 时，账号密码根本不会被用到**，可以留空。 -在用户页配置该用户要执行哪些模块： +另外，别把你的 `data/` 目录或脚本配置 JSON 发给别人，里面有加密后的凭据。 +::: + +### 这个用户要跑哪些任务 | 开关 | 说明 | 默认 | |---|---|---| -| **体力** | 是否执行体力副本 + 历战余响 | 关闭 | -| **日常与奖励** | 是否执行兑换码、邮件、委托、勋礼、每日实训等 | 关闭 | -| **三深渊**（每月一次，三个一起执行） | 当前 UI **禁用**，是否启用以你实际版本界面为准 | 关闭 | -| **差分 / 货币** | 三选一：关闭 / 差分宇宙 / 货币战争 | 关闭 | +| **体力** | 体力副本 + 历战余响 | 关闭 | +| **日常与奖励** | 兑换码、邮件、委托、勋礼、每日实训等 | 关闭 | +| **三深渊** | 每月一次，三个一起跑。当前版本界面上是禁用的 | 关闭 | +| **差分 / 货币** | 三选一：都不跑 / 差分宇宙 / 货币战争 | 关闭 | -按你 TaskMapping 中选择的引擎，UI 会显示对应的执行策略（与脚本页一致）。 +打开开关后，下面会显示这个任务将用哪个脚本、按什么策略跑，和脚本页显示的一致，不用重复设置。 ## 配置体力副本 -进入 **体力配置** 区，可以看到四个独立的下拉框： +**体力配置** 区有四个下拉框，对应四类副本。不想刷的留空就行： -| 通道 | 对应副本类型 | +| 下拉框 | 刷的是 | |---|---| | **拟造花萼（金）** | 角色经验 / 光锥经验 / 信用点 | -| **拟造花萼（赤）** | 行迹材料（金/赤互不覆盖，可同时保存） | -| **侵蚀隧洞** | 遗器副本 | -| **饰品提取** | 位面饰品副本 | - -每个通道都是独立可选项；不刷的副本可以不选。 - -接着是： - -- **刷取副本**：选择本次要刷的通道（金/赤/遗器/饰品），会写入 `Stage.Channel`。 -- **当前生效关卡**：UI 展示当前 `Stage.ScriptStage` 对应的关卡名/关卡 ID。 -- **历战余响**：从外部脚本读取的历战余响关卡中选一个；不刷可以留空。 -- **历战余响开始日**：周一 ~ 周日。到达开始日且本周未完成时，AUTO-MAS 会交给 M7A / SRA 尝试完成；日志确认完成后本周不再执行。 - -### 副本选项从哪里来？ +| **拟造花萼（赤）** | 行迹材料 | +| **侵蚀隧洞** | 遗器 | +| **饰品提取** | 位面饰品 | -体力副本选项**只来自外部脚本暴露的副本配置**，按你 TaskMapping 中「体力」模块选择的引擎动态读取： +金和赤的选择互不影响，可以同时存着。 -- M7A：从 `instance_names.json` 读取 -- SRA：从 `trailblaze_power.toml` 读取 +下面还有几项： -如果下拉框为空，常见原因： +- **刷取副本**：从上面四类里挑本次实际要刷的那一类。 +- **当前生效关卡**：显示你选中的关卡，只是给你确认用的。 +- **历战余响**：从脚本读出来的关卡里挑一个，不刷就留空。 +- **历战余响开始日**：设成周几，到了那天本周还没刷就去刷。刷完这周就不再重复。 -1. 外部脚本（M7A / SRA）还没初始化过；请先手动打开一次。 -2. 外部脚本路径填错，导致 AUTO-MAS 找不到配置文件。 -3. 切换了 TaskMapping 中的体力执行引擎（例如从 SRA 切到 M7A），需要**重新选择副本**。 +### 下拉框是空的？ -> 切换体力执行引擎时，体力配置区会出现黄色提示「体力执行脚本已切换，请重新选择副本。」 +因为这些副本选项不是 AUTO-MAS 自己编的，而是**从你的 M7A / SRA 里读出来的**——你把体力交给谁，就读谁的配置。所以空了基本是这三个原因： -## 周常 / 月常说明 +1. **脚本没初始化过** → 手动打开 M7A / SRA 一次，等它跑完。这是最常见的原因。 +2. **脚本路径填错了** → AUTO-MAS 找不到配置文件，回去检查路径。 +3. **刚换了执行脚本**（比如体力从 SRA 换成 M7A）→ 两边的副本列表不一样，需要**重新选一次副本**。这时页面上会有黄色提示。 -HSR 专项的周常 / 月常进度由 AUTO-MAS 自动记录，**用户页不要求手动选择「差分宇宙 1 / 差分宇宙 2」等**： +## 周常和月常不用你操心 -- **差分宇宙、货币战争**：属于周常类任务；完成状态按 ISO 周（形如 `2025-W23`）自动记录。本周已完成的周常，下次执行会被跳过。 -- **三深渊**：属于月常类任务；每月执行一次，由三份快照（混沌回忆 / 虚构叙事 / 末日幻影）组成。完成状态按自然月（形如 `2025-06`）自动记录。 -- **历战余响**：按 ISO 周重置；用户可以指定「历战余响开始日」，到达后才尝试执行，本周完成后不再重复。 +这类任务 AUTO-MAS 会自己记账，**用户页不需要你手动挑「差分宇宙 1 / 差分宇宙 2」之类的东西**： -### 进度与重置 +- **差分宇宙、货币战争、历战余响**：按周记录。这周做完了，之后再跑会自动跳过，下周一自动解锁。 +- **三深渊**：按月记录，每月跑一次。 -用户页底部「**进度与重置**」区提供三个手动控制项： +### 手动改进度 -- **历战余响**：显示「本周已完成 / 未完成」与最近完成日期。提供「标记完成 / 重置」按钮。 -- **周常**：同上，按 ISO 周判定。 -- **三深渊**：按自然月判定，提供「标记本月完成 / 重置」按钮。 +用户页底部的 **进度与重置** 区，可以看到历战余响、周常、三深渊各自"本周/本月做没做过"，每项都能手动 **标记完成** 或 **重置**。 -> 这三个按钮只修改本地的 `Data` 字段，**不会实际驱动外部脚本**；它们用于在外部脚本已确认完成、或你希望强制重跑某项时快速同步状态。 +两种情况用得上：你已经自己进游戏做完了，标记一下让 AUTO-MAS 别再跑；或者你想强制重跑一次，点重置。 -### 关于三深渊 - -AUTO-MAS 准备了完整的三深渊流水线，包括： - -- 用户页：可开关 ForgottenHall 并在 UI 导入三份快照 -- 脚本页：可从 M7A 的 `config.yaml` 一键导入「混沌回忆 / 虚构叙事 / 末日幻影」三份快照 - -但**当前 PR #249 阶段在用户页将三深渊开关禁用**，以避免在不充分的测试下被误用。后续会随版本逐步开放，请以你 AUTO-MAS 实际界面为准。 +::: tip 这几个按钮只改记录 +它们只改 AUTO-MAS 自己的记账，**不会真的去驱动脚本执行任务**。 +::: ## 运行与日志 -配好脚本和用户后，可把脚本加入任务调度队列执行。日常使用要点： - -- **M7A / SRA 切换时 AUTO-MAS 会重启游戏**：这是为了避免外部脚本状态互相污染；属于预期行为。 -- **M7A / SRA 各自的配置 AUTO-MAS 不会破坏**：运行前会备份 `config.yaml` / `settings.json` / `cache.json` / `configs`，运行后自动恢复。 -- **失败自动补跑**：模块内单条任务失败时，会按「失败任务最大尝试次数」自动补跑；补跑前 AUTO-MAS 会先重启游戏。 +配好之后，把脚本加进 [调度队列](/docs/task-scheduler) 就能自动跑了。三件事值得知道： -### 日志位置 +- **游戏可能被反复重启**：同一个用户的任务分给了两个不同脚本时，切换时会重启游戏。这是故意的，为了防止两个脚本的状态互相干扰。 +- **你的 M7A / SRA 配置不会被弄坏**：AUTO-MAS 跑之前先备份，跑完自动还原。 +- **失败会自动重跑**：按你设的「失败任务最大尝试次数」重试，重试前先重启游戏。 -排查问题请提供： +### 出问题要交哪些日志 -- `debug/app.log`：AUTO-MAS 主程序日志 -- `debug/frontend.log`：前端日志 +- `debug/app.log` —— AUTO-MAS 主程序日志 +- `debug/frontend.log` —— 界面日志 -如果问题与某个外部脚本相关，请同时附上 M7A / SRA 的运行日志目录（路径请参见各脚本的官方文档）。 +如果看起来是某个脚本本身的问题，再附上 M7A / SRA 自己的日志（位置见各脚本文档）。 ## 常见问题 -### 找不到 HSR 脚本类型 +### 新建脚本时没有 HSR 这个选项 -- 确认你使用的 AUTO-MAS 版本已合并 [PR #249](https://github.com/AUTO-MAS-Project/AUTO-MAS/pull/249)。 -- 重新启动 AUTO-MAS 让前端 OpenAPI 客户端重新生成。 +你的 AUTO-MAS 版本太老，还没有 HSR 专项，去 [下载页](/download/auto-mas) 更新。更新后重启一次软件。 -### 路径校验失败 +### 路径怎么填都提示不对 -- 「三月七路径」选错目录：必须包含 `March7th Assistant.exe`。 -- 「SRA 路径」选错目录：必须包含 `SRA-cli.exe`。 -- 「游戏路径」选错目录：必须包含 `StarRail.exe`。 -- 注意：是选 **目录**（文件夹），不是选 `exe` 本身。 +**你可能选到了 exe 本身。这里要选的是文件夹。** 确认文件夹里直接放着对应的 exe：三月七是 `March7th Assistant.exe`、SRA 是 `SRA-cli.exe`、游戏是 `StarRail.exe`。也别选到子目录里去。 -### 副本列表为空 +### 副本列表是空的 -- 确认 M7A / SRA 已经手动打开过一次，初始化了 `config.yaml` / `settings.json`。 -- 确认脚本路径填的是外部脚本**根目录**，不是某个子目录。 -- 若你刚切换了「体力」模块的执行引擎，请按页面提示重新选择副本。 +按顺序查：M7A / SRA 手动打开过一次了吗（最常见）→ 路径填的是脚本根目录吗 → 刚换过体力的执行脚本吗（换了要重选副本）。 -### 任务完成状态不符合预期 +### 任务状态不对，该跑的没跑 / 跑过了又跑 -- 检查「每日任务」「周常/月常」开关是否符合预期。 -- 周常按 ISO 周重置，月常按自然月重置；跨周/跨月后状态会自动重置。 -- 查看 `debug/app.log` 中关于 M7A / SRA 子进程退出码与判定 marker 的日志。 -- 在「进度与重置」区可以手动标记完成或重置来同步状态。 +- 先看用户页的任务开关是不是你想的那样。 +- 周常按周重置、月常按月重置，跨周跨月会自动清零。 +- 在 **进度与重置** 区手动标记或重置，可以立刻纠正状态。 +- 还是不对就看 `debug/app.log`，里面有脚本退出情况的记录。 -### M7A 差分宇宙看起来跑得不太稳 +### M7A 跑差分宇宙不太稳 -- 启用脚本页的「启用低性能兼容模式」开关。 -- 球队 / 赐福 / 演算策略由 M7A 客户端自行决定，请提前在 M7A 本体中配置好。 +打开脚本页的 **启用低性能兼容模式**。另外球队、赐福、演算策略这些 AUTO-MAS 管不到，得你提前在 M7A 里配好。 -### SRA 货币战争完成后没有积分 +### SRA 跑完货币战争没积分 -- 这是已知行为。SRA 货币战争完成后**不会自动领取积分奖励**，请在游戏内手动领取。 +已知行为，SRA 不会自动领，自己进游戏领一下。想省这一步就把货币战争改交给 M7A。 -### 调度过程中游戏被反复重启 +### 游戏被反复重启 -- 当同一用户的不同模块由不同引擎（一个 M7A、一个 SRA）执行时，AUTO-MAS 会在切换时重启游戏以避免脚本状态污染，属于预期行为。 -- 如希望减少重启，可以在 TaskMapping 中把多模块统一交给同一个引擎。 +同一个用户的任务分给了两个不同脚本，切换时就会重启游戏，这是故意的，防止状态互相干扰。嫌烦就把任务都交给同一个脚本。 -### 任务失败但日志里看不到 M7A / SRA 输出 +### 任务失败了，但日志里没有脚本的输出 -- 确认 Windows Defender / 杀软没有拦截子进程。 -- 确认外部脚本路径没有中文、空格或符号链接。 -- 把 M7A / SRA / 星穹铁道安装目录加入杀软信任区后再试。 +说明脚本压根没跑起来，基本是被杀软拦了。把 M7A、SRA、游戏三个目录都加进杀软信任区再试。也顺便确认路径里没有中文、空格或符号链接。 ## 反馈与帮助 diff --git a/docs/script-guide/index.md b/docs/script-guide/index.md index 0212ccc..8412fdb 100644 --- a/docs/script-guide/index.md +++ b/docs/script-guide/index.md @@ -1,6 +1,8 @@ # 脚本管理 -AUTO-MAS 支持多种游戏脚本的管理与调度。本节将介绍如何在 AUTO-MAS 中使用各类脚本。 +找到你玩的那个游戏，点进去照着配就行。 + +玩的游戏不在下面这个列表里？看 [通用调度](/docs/script-guide/general)——只要那个脚本能"启动后自动开跑"并且会写日志，AUTO-MAS 就能管它。 ## 指南目录 @@ -36,22 +38,20 @@ AUTO-MAS 支持多种游戏脚本的管理与调度。本节将介绍如何在 A 鸣潮（Wuthering Waves） - OK-WW -- ok-script 家族中的鸣潮子项目，与异环的 OkNte 分开配置 -- 当前专项入口接管日常与多账号日常（`-t 1`、`-t 7`） -- 支持 MAS 全自动游戏生命周期管理（启动/关闭） -- 配置来源分为脚本、用户、直控；可选择接管具体任务配置，覆盖高频任务字段 -- 仅支持鸣潮官方启动器和官方资源，不使用 WeGame +- 目前支持日常任务与多账号日常 +- AUTO-MAS 可以帮你自动开关游戏 +- 复杂设置仍在 OK-WW 自己界面里做，AUTO-MAS 只接管高频项 +- 只支持官方启动器，不支持 WeGame --- ### [HSR](/docs/script-guide/hsr) -崩坏：星穹铁道 - HSR 专项（M7A / SRA 双引擎） +崩坏：星穹铁道 - 三月七小助手（M7A）+ StarRailAssistant（SRA） -- 同时支持三月七小助手（M7A）与 StarRailAssistant（SRA）双引擎 -- 覆盖日常清体力、奖励领取、差分宇宙、货币战争等任务 -- 体力 / 奖励 / 差分 / 货币 四个模块可独立选择 M7A 或 SRA 执行 -- 失败任务自动补跑，外部脚本配置零污染 +- 两款脚本可以混着用，哪个任务交给谁由你定 +- 覆盖清体力、领奖励、差分宇宙、货币战争 +- 失败自动重跑，不会弄坏你原本的脚本配置 --- @@ -71,14 +71,3 @@ AUTO-MAS 支持多种游戏脚本的管理与调度。本节将介绍如何在 A - 🚀 开发中，敬请期待 - 🔐 可配合自动登录脚本使用 - ---- - -## 阅读建议 - -- **新手推荐**：从 [MAA 用户指南](/docs/script-guide/maa) 开始（如果玩明日方舟） -- **鸣潮玩家**：查看 [OK-WW 配置方法](/docs/script-guide/okww) 快速上手 -- **1999 玩家**：查看 [M9A 配置方法](/docs/script-guide/m9a) 快速上手 -- **星穹铁道玩家**：查看 [HSR 配置方法](/docs/script-guide/hsr) 快速上手 -- **其他游戏**：查看 [通用调度](/docs/script-guide/general) 并使用现成模板 -- **高级用户**：深入了解[通用调度](/docs/script-guide/general)的配置管理逻辑，自定义您的调度方案 diff --git a/docs/script-guide/m9a.md b/docs/script-guide/m9a.md index dc4b4f0..640b823 100644 --- a/docs/script-guide/m9a.md +++ b/docs/script-guide/m9a.md @@ -37,34 +37,28 @@ M9A 是一个《1999》（亿韭韭韭）第三方软件，能够轻松完成199 ### 运行配置项 -M9A 脚本提供以下运行控制参数： - | 配置项 | 说明 | 默认值 | |--------|------|--------| -| 代理次数限制 | 单个用户每日最大代理次数，0 表示无限制 | 0 | -| 运行次数限制 | 任务异常时的最大重试次数 | 3 | -| 运行时间限制 | 单次任务最大运行时间（分钟），超时将强制终止 | 10 | -| 队列结束后自动更新 | 批量任务完成后，若检测到新版本则自动更新 M9A 资源 | 关闭 | +| 代理次数限制 | 单个用户每天最多代理几次，0 是不限制 | 0 | +| 运行次数限制 | 任务失败后最多重试几次 | 3 | +| 运行时间限制 | 单次任务最多跑几分钟，超时强制结束 | 10 | +| 队列结束后自动更新 | 队列跑完后，检测到新版本就自动更新 M9A 资源 | 关闭 | -> 💡 **提示**: 开启"队列结束后自动更新"后，AUTO-MAS 会在所有真实用户任务完成后，启动虚拟用户执行资源更新，并在更新成功后发送桌面和 Webhook 通知。 -> -> ⚠️ **重要**: 使用自动更新功能前，请确保已手动打开 M9A 并在 M9A 设置中 **单独开启资源更新渠道**（选择 Mirror 酱 或 GitHub），否则自动更新将无法正常工作。 +::: warning 想用自动更新，得先在 M9A 里开好更新渠道 +**队列结束后自动更新** 依赖 M9A 自己的更新功能。请先手动打开 M9A，在设置里**单独开启资源更新渠道**（Mirror 酱 或 GitHub），否则这个开关不起作用。 +::: -## 首次运行前准备 +## 首次运行前必做 -::: warning 重要 -首次在 AUTO-MAS 中使用 M9A 前，请先手动启动一次 M9A，完成以下初始化操作： -::: +第一次在 AUTO-MAS 里用 M9A 之前，**必须先手动打开 M9A 一次**，让它把自己初始化好： -1. 手动启动 M9A 主程序（`M9A.exe`） -2. 等待 M9A 完成初始化（日志显示 "AgentServer 启动" 后，等待 "任务已全部完成"） -3. 在 M9A 设置中： - - 配置 **资源下载源**（选择 Mirror 酱 或 GitHub） - - 填写 **CDK** 或 **Token**（用于更新资源） -4. 由您自行在 M9A 中确定是否开启 **自动更新** 和选择 **更新渠道** -5. 确认后关闭 M9A +1. 双击 `M9A.exe` 启动。 +2. 等它初始化完（日志出现 "AgentServer 启动"，然后等到 "任务已全部完成"）。 +3. 在 M9A 设置里配好 **资源下载源**（Mirror 酱 或 GitHub）和对应的 **CDK / Token**。 +4. 顺便决定要不要开 M9A 自己的 **自动更新**，这个由你自己定。 +5. 关掉 M9A。 -完成以上步骤后，回到 AUTO-MAS 点击 **保存配置**。 +回到 AUTO-MAS 点 **保存配置**，然后就能正常用了。 ## 配置用户 @@ -91,139 +85,68 @@ M9A 支持的任务包括（以软件实际版本为准）： ### 预设模板 -当任务队列为空时，系统会显示 **日常-长草** 预设模板，一键即可批量添加常用任务到队列中。 - -**日常-长草** 模板包含以下任务（适用于无活动或换完商店时的日常刷取）： - -| 任务 | 说明 | -|------|------| -| 收取荒原 | 收取荒原资源 | -| 每日心相（意志解析） | 自动完成意志解析 | -| 常规作战 | 日常关卡作战 | -| 自动深眠 | 自动完成深眠挑战 | -| 自动醒梦 | 自动完成醒梦 | -| 银行购物 | 自动银行购物 | -| 领取奖励 | 自动领取各类奖励 | -| 使用兑换码 | 自动使用兑换码 | - -> 💡 **提示**: 预设模板仅作为快速添加入口的辅助功能，您仍可以通过 **添加任务** 按钮手动构建任务队列，或者在预设任务基础上增删改。一键添加时，若部分任务未找到对应脚本定义，已自动跳过。 - -### 账号切换功能 - -M9A 支持自动切换账号功能，便于多账号管理： - -1. 在用户配置页面的 **账号信息** 字段中填写要切换的目标账号（仅官服有效） -2. 当服务器资源选择为 **官服** 且填写了账号信息时，AUTO-MAS 会自动在任务队列开头插入 **切换账号** 任务 -3. 切换账号任务会在 **启动游戏** 之后、用户自定义任务之前执行 - -> 💡 **提示**: 若无需切换账号，请留空账号信息字段。其他服务器暂不支持账号切换功能。 - -### 已知限制 +懒得一个个加任务？任务队列为空时会出现 **日常-长草** 模板，点一下就把常用任务全加进来（适合没活动、或者商店已经换完的日常）： -- ✅ **官服**：支持（唯一支持账号切换功能的服务器） -- ✅ **B服**：支持（受 M9A 限制，不支持账号切换） -- ✅ **其他服务器**：支持（受 M9A 限制，不支持账号切换） -- ✅ **MuMu 模拟器**：支持 -- ✅ **雷电模拟器**：支持 -- ❌ **通用模拟器**：未测试 -- ❌ **MXU 图形界面**：不支持，仅支持 MFAAvalonia +收取荒原、每日心相（意志解析）、常规作战、自动深眠、自动醒梦、银行购物、领取奖励、使用兑换码。 -## 配置说明 +加进来之后照样可以随便增删改。如果模板里某个任务你的 M9A 版本没有，会自动跳过。 -以下为 **自动代理** 模式下，AUTO-MAS 针对 M9A 的配置策略。 +### 自动切换账号 -1. 用户配置页展示的配置项优先生效。 -2. AUTO-MAS 会根据您配置的任务队列，自动构建 M9A 的实例配置文件。 -3. **任务队列自动构建规则**： - - 自动在队列开头添加 **启动游戏** 任务 - - 若为官方服务器且填写了账号信息，自动在 **启动游戏** 后插入 **切换账号** 任务 - - 自动过滤用户手动添加的 **启动游戏**、**关闭游戏**、**切换账号** 任务（避免重复） - - 自动在队列末尾添加 **关闭游戏** 任务 - - 自动跳过标记为 `standalone` 的独立任务 - - 最终执行顺序：`启动游戏 → [切换账号] → 用户自定义任务 → 关闭游戏` -4. **配置安全保障**： - - AUTO-MAS 会在运行前自动备份 M9A 的整个 `config` 目录 - - 运行期间只修改 `config/instances/default.json` 文件 - - 您的 `config.json` 全局配置不会被修改 - - 任务结束后会自动还原原始配置 +**只有官服支持**，其他服受 M9A 限制做不到。 -## 配置隔离机制 +在用户配置页的 **账号信息** 里填上目标账号就行——填了之后，AUTO-MAS 会自动在任务队列开头插一个 **切换账号** 任务（在启动游戏之后、你的任务之前）。不需要切号就留空。 -### 工作原理 +### 支持范围 -AUTO-MAS 实现了完整的配置隔离机制，确保您的 M9A 原始配置安全： +| | 状态 | +|---|---| +| 官服 | 支持，且是唯一能自动切号的服 | +| B服 / 其他服 | 支持，但不能自动切号（M9A 的限制） | +| MuMu 模拟器 / 雷电模拟器 | 支持 | +| 其他模拟器 | 没测过，可能有问题 | +| MXU 界面 | 不支持，只支持 MFAAvalonia | -1. **运行前备份**：将整个 `config` 目录备份到临时路径 -2. **运行时隔离**：只修改实例配置文件，全局配置保持不变 -3. **运行后还原**：完整恢复原始配置状态 +## 你的 M9A 配置会被改坏吗 -### 优势 +不会。AUTO-MAS 跑之前会把 M9A 整个 `config` 目录备份一份，运行期间只动实例配置那一个文件（`config/instances/default.json`），你的全局配置 `config.json` 一个字都不碰，跑完再把原配置还回去。 -- ✅ 配置安全：不用担心配置被污染 -- ✅ 自动还原：每次运行都是干净的状态 -- ✅ 调试友好：自动保存历史配置备份（`data/script_id/test*.json`） +想事后对照排查，每次运行用的配置都存在 `data/script_id/test*.json`，保留最近 5 份。 -## M9A 自动更新机制 +### 任务队列是怎么拼出来的 -### 功能说明 +你在界面上排的任务不是原样交给 M9A 的，AUTO-MAS 会自动补齐首尾： -当开启 **队列结束后自动更新** 选项后，AUTO-MAS 会在所有真实用户任务完成后自动检测并更新 M9A 资源： +```text +启动游戏 → [切换账号] → 你排的任务 → 关闭游戏 +``` -1. **版本检测**：在首个用户运行期间，AUTO-MAS 会监控 M9A 日志，检测是否有新版本提示 -2. **虚拟用户更新**：若检测到新版本，系统会启动一个虚拟用户（不连接模拟器），仅用于执行资源更新 -3. **更新监控**：实时监控更新过程，检测网络中断、HTTP 错误、超时等异常 -4. **通知推送**：更新成功或失败后，会发送桌面通知和 Webhook 通知 +所以有两件事你不用管： -### 更新失败处理 +- **启动游戏、关闭游戏不用自己加**，会自动补。手动加了也会被过滤掉，不会重复执行。 +- **切换账号也不用自己加**，官服且填了账号信息时自动插入。 -若更新失败，系统会： -- 记录详细错误日志到 `data/script_id/` 目录 -- 发送包含失败原因的通知（如"网络连接中断"、"HTTP 请求失败"等） -- 保留当前版本，不影响下次正常运行 +## 自动更新是怎么跑的 -### 注意事项 +开了 **队列结束后自动更新** 之后，流程是这样的：第一个用户跑的时候 AUTO-MAS 顺便看一眼 M9A 日志里有没有提示新版本；有的话，等所有用户都跑完，再单独跑一次更新（不连模拟器，纯粹为了更新资源）；更新完发通知告诉你结果。 -- 更新期间 M9A 会自动重启应用，这是正常现象 -- 更新超时时间为 10 分钟 -- 建议在网络稳定的环境下开启自动更新 +- 更新时 M9A 会自己重启，正常现象。 +- 更新最多等 10 分钟。 +- 网络不稳的时候别开这个，失败了虽然不影响下次运行，但白等一场。失败原因会写进 `data/script_id/` 目录，也会在通知里告诉你。 ## 常见问题 -### Q: 可以在一个脚本下添加多个用户吗？ - -A: 需要确认您的M9A版本，新版本M9A已支持指定账号切换，您可以依托新版本的M9A自行构建账号切换任务。AUTO-MAS 支持在单个脚本下管理多个用户，会依次执行每个用户的任务队列。 - -### Q: 支持哪些模拟器？ - -A: 已测试支持 **MuMu 模拟器** 和 **雷电模拟器**。其他模拟器未测试，可能存在兼容性问题。 - -### Q: 支持 MXU 图形界面吗？ - -A: 不支持。M9A 适配仅支持 **MFAAvalonia** 图形界面。 - -### Q: 我的 M9A 配置会被修改吗？ - -A: 不会。AUTO-MAS 只修改 `config/instances/default.json`，并且会在任务结束后完整还原您的原始配置。 - -### Q: 如何查看之前运行的配置（主要用来debug）？ - -A: 每次运行的配置都会保存到 `data/script_id/test*.json`，最多保留最近 5 个备份。 - -### Q: 任务执行失败怎么办？ - -1. 检查运行时模拟器连接状态 -2. 查看日志文件分析错误原因 -3. 在 `data/script_id/` 目录下查看历史配置进行对比 +### 一个脚本下能加多个用户吗？ -### Q: 任务队列需要手动添加"启动游戏"和"关闭游戏"吗？ +能，AUTO-MAS 会按列表顺序依次跑每个用户的任务队列。想让它自动切号需要新版 M9A（支持指定账号切换），且只有官服可用。 -A: 不需要。AUTO-MAS 会自动在任务队列开头添加 **启动游戏**，在末尾添加 **关闭游戏**。如果您手动添加了这些任务，系统会自动过滤以避免重复执行。 +### 任务失败了怎么查？ -### Q: "队列结束后自动更新"是如何工作的？ +按顺序：先看模拟器连上了没 → 再看日志找报错 → 还不清楚就去 `data/script_id/` 里翻这次实际用的配置，和上次成功的比一比。 -A: 开启后，系统会在所有真实用户任务完成后，检测 M9A 是否有新版本。若有新版本，会启动一个虚拟用户（不连接模拟器，仅用于更新），自动下载并应用最新的 M9A 资源包。更新完成后会发送通知告知结果。 +### 代理次数怎么不涨？ -### Q: 为什么我的代理次数没有增加？ +**次数是按 UTC+4 时区算日期的**，和你电脑的日期可能差几小时，跨日时间点不是本地 0 点。 -A: 代理次数以 UTC+4 时区的日期为准。如果当天的代理次数已达到脚本配置中的 **代理次数限制**，后续用户将被跳过。每日首次代理时会自动重置计数器。 +另外，当天次数已经达到 **代理次数限制** 的话，后面的用户会被直接跳过。每天第一次代理时计数器自动清零。 diff --git a/docs/script-guide/maa.md b/docs/script-guide/maa.md index 1b31bd1..bc0ea21 100644 --- a/docs/script-guide/maa.md +++ b/docs/script-guide/maa.md @@ -76,28 +76,29 @@ MAA 是一个明日方舟第三方软件，能够轻松完成明日方舟日常 经过这些修改，你应该能够稳定的进行账号切换 ::: -### 配置说明 +### AUTO-MAS 会替你改哪些 MAA 设置 -以下为 **自动代理** 模式下，AUTO-MAS 针对 MAA 的配置策略。 +跑自动代理时，有些 MAA 设置由 AUTO-MAS 接管，你在 MAA 里怎么设都会被覆盖。知道这一点能省掉很多"我明明设过了"的困惑： -1. 用户配置页展示的配置项优先生效。 -2. **剿灭** 任务中，仅开启 **开始唤醒**、**刷理智** 任务，**刷理智** 中仅进行 **剿灭模式** 关卡代理，任务配置内容由程序按用户配置自动生成；**日常** 任务中，开启 **任务配置** 中启用的任务，任务顺序固定无法修改。 -3. **定时执行** 保持关闭，**任务完成后行为**、**启动 MAA 后行为**、**MAA 最小化相关设置**、**更新相关设置** 按实际配置与执行情况自动调整。 -4. **简洁** 配置模式下其他配置沿用 **MAA 全局设置**；**详细** 配置模式下其他配置沿用 **用户具体配置**。在任务配置中，同类型任务仅第一个生效，若找不到同类型任务，则使用默认值。 +- **用户配置页里出现的选项，一律以用户页为准。** +- **剿灭任务**：只开 **开始唤醒** 和 **刷理智**，且只刷剿灭关卡，具体配置由程序按你的用户设置自动生成。 +- **日常任务**：跑你在 **任务配置** 里勾选的任务，**顺序是固定的，改不了**。 +- **定时执行** 会被强制关掉（定时交给 AUTO-MAS 的调度队列管）。任务完成后行为、启动后行为、最小化、更新这几类设置也会被自动调整。 -## 计划表 +没被接管的设置，取决于你用哪种配置模式：**简洁** 模式沿用 MAA 的全局设置，**详细** 模式沿用该用户自己的具体配置。 -依靠计划表，您可以以周为单位定制关卡代理方案。 - -![plan](../img/advanced-features/plan-1.png) +::: tip 同类型任务只有第一个生效 +如果你在 MAA 里排了两个同类型的任务（比如两个"刷理智"），只有第一个会被 AUTO-MAS 采用。一个都没有时用默认值。 +::: -十分通俗易懂！ +## 计划表：周一到周日刷不同的关 -切换配置模式为周计划模式后，你就可以决定不同时间刷什么。 +想周中刷经验、周末刷钱？用计划表按周排关卡。 -切换为简化视图，可以拥有类似 mower 的编辑体验。 +![plan](../img/advanced-features/plan-1.png) -之后，你可以在 MAA 用户界面的关卡配置模式中选择计划表。 +1. 把配置模式切成 **周计划模式**，然后填每天刷什么。嫌表格太占地方，可以切 **简化视图**，编辑体验类似 mower。 +2. 回到 MAA 用户界面，在 **关卡配置模式** 里选中你的计划表。 ![plan](../img/advanced-features/plan-2.png) diff --git a/docs/script-guide/maaend.md b/docs/script-guide/maaend.md index d44ce3e..59f43de 100644 --- a/docs/script-guide/maaend.md +++ b/docs/script-guide/maaend.md @@ -21,10 +21,9 @@ MaaEnd 是一个「明日方舟：终末地」第三方自动化工具，基于 1. 前往 或 下载软件压缩包。 2. 将 MaaEnd 压缩包解压至任意文件夹。 -::: warning 温馨提醒 -请不要将 MaaEnd 解压在中文路径下，以免出现不必要的异常。 - -与其他脚本一样，不允许将MaaEnd脚本放置在MAS根目录下以避免可能带来的错误删除风险 +::: warning 解压位置有两个禁区 +- **别放在中文路径下**，容易引发莫名其妙的报错。用 `D:\MaaEnd` 这样的纯英文路径。 +- **别放在 AUTO-MAS 根目录里面**。和其他脚本一样，放在里面有被误删的风险。 ::: ## 配置脚本 @@ -37,23 +36,24 @@ MaaEnd 是一个「明日方舟：终末地」第三方自动化工具，基于 1. 根据需要调整以下配置： - | 配置项 | 说明 | + | 配置项 | 填什么 | | --- | --- | - | **控制器类型** | 选择操控方式。这里的操控方式会复写配置MAAEND的设定。我们推荐您使用PC端，模拟器需要更新至v5.4.0或公测版才可以使用| - | **（PC端）游戏路径** | 终末地游戏可执行文件路径 | - | **（PC端）游戏启动参数** | 启动游戏时的附加命令行参数，无特别需要留空即可 | - | **（PC端）游戏启动后等待时间** | 启动游戏后等待多少秒再开始自动化，默认 60 秒 | - | **任务完成后关闭游戏** | 最后一个用户任务完成后是否自动关闭游戏 | - | **代理超时限制** | 日志无变化超过多少分钟视为超时，默认 10 分钟 | - | **每日代理次数限制** | 每个用户每天最多代理几次，0 为不限制 | - | **单次最大重试次数** | 代理失败后最多重试几次，默认 3 次 | + | **控制器类型** | 用 PC 端还是模拟器。**推荐 PC 端**。这里选的会覆盖你在 MaaEnd 里的设置 | + | **（PC端）游戏路径** | 选 `Endfield.exe`，**不是**鹰角启动器 | + | **（PC端）游戏启动参数** | 留空 | + | **（PC端）游戏启动后等待时间** | 启动游戏后等几秒再开始操作，默认 60 秒 | + | **任务完成后关闭游戏** | 全部用户跑完后要不要自动关掉游戏 | + | **代理超时限制** | 日志多少分钟没动静就算卡死，默认 10 分钟 | + | **每日代理次数限制** | 每个用户每天最多代理几次，0 是不限制 | + | **单次最大重试次数** | 失败后最多重试几次，默认 3 次 | 2. 点击 **保存配置**。 -::: info 关于模拟器 +::: warning 要用模拟器？先确认版本 +控制器类型选模拟器（ADB）时有两个前提： -- **ADB**：需要在 **模拟器管理** 中配置好模拟器。 -- 由于上游MFW命名规则变更，需要您更新至v5.4.0或公测版以正确传递模拟器参数。 +- 先去 **模拟器管理** 把模拟器配好，否则连不上。 +- **MaaEnd 必须是 v5.4.0 或公测版**。上游 MFW 改了命名规则，旧版本收不到 AUTO-MAS 传过去的模拟器参数。 ::: ## 配置用户 @@ -67,46 +67,58 @@ MaaEnd 是一个「明日方舟：终末地」第三方自动化工具，基于 #### 基本信息 -| 配置项 | 说明 | +| 配置项 | 填什么 | | --- | --- | -| **用户名** | 用户显示名称，用于区分不同账号 | -| **启用状态** | 是否参与自动代理。关闭后该用户将被跳过 | -| **账号 ID** | 终末地登录手机号（11 位数字）。留空则不进行账号切换 | -| **密码** | 终末地登录密码（加密存储）。无作用| -| **配置文件来源** | `脚本级` 使用脚本级 MaaEnd 配置；`用户级` 使用该用户独立的 MaaEnd 配置 | -| **接管具体游戏配置** | 关闭后下方任务配置不可用，仅按照保存的配置文件执行代理 | -| **剩余天数** | 剩余有效代理天数。`-1` 为无限制，每次成功代理后自动减 1，减至 0 时跳过该用户 | -| **备注** | 自由备注信息 | +| **用户名** | 显示名称，自己认得出就行 | +| **启用状态** | 关掉的用户会被跳过 | +| **账号 ID** | 终末地登录手机号（11 位）。留空就不切号，直接用当前登录的账号 | +| **密码** | 目前没有作用，可以不填 | +| **配置文件来源** | `脚本级` 所有用户共用一份 MaaEnd 配置；`用户级` 这个用户单独一份 | +| **接管具体游戏配置** | 打开才能用下面的任务配置。关掉就完全按已保存的配置文件跑 | +| **剩余天数** | 还能代理几天。`-1` 是不限制，跑成功一次减一天，减到 0 就跳过这个用户 | +| **备注** | 随便写 | -#### 任务配置说明 +#### 任务配置 -MAS会尝试按照您的设定开关任务，若不存在相应的任务会跳过 +AUTO-MAS 会按你的设定去开关 MaaEnd 里的任务。**你的 MaaEnd 里没有的任务会被直接跳过**，不会报错。 ##### 理智任务选项 -仅会在启用了理智任务的情况下出现，允许您在MAS内快捷修改理智任务。 + +只有启用了理智任务时才会出现，让你不用打开 MaaEnd 就能改理智任务的设置。 + ![理智任务](/docs/img/script-guide/maaend/理智任务.png) -::: tip 账号切换说明 -我们推荐您使用“MAS自建切号”，一般来说其具有更好的稳定性；若失败，也可以尝试切换到MaaEnd切号，MAS会自动为您添加切号任务，您无需手动添加 +::: tip 切号优先用 MAS 自建切号 +两种切号方式里，**MAS 自建切号** 通常更稳，先用它。如果切不成功，再换成 MaaEnd 切号——换过去之后 AUTO-MAS 会自动帮你加切号任务，不用你自己去 MaaEnd 里添加。 ::: ## 森空岛自动签到 -迁移至签到工具内。 +已经搬到 [游戏签到工具](/docs/advanced-features/game-sign) 里了，去那边配。 -### 结果推送说明 +## 额外的结果推送 -如您打开了基质刷取的任务后机制筛选，MAS会额外向您推送基质刷取结果； - -如您添加了抽数计算，MAS会额外向您推送抽数计算结果 +这两项打开后，通知里会多给你一份结果： +- 开了**基质刷取的任务后机制筛选** → 多推一份基质刷取结果。 +- 加了**抽数计算** → 多推一份抽数计算结果。 ## 常见问题 -1. Endfield启动需要时间略长，我们建议您不要降低默认的等待时间(60s) -2. 前台模式下会完全的占用鼠标，如您在代理时操作键盘鼠标可能会导致代理失败、 -3. 请务必注意，游戏路径需要选择Endfield.exe而非鹰角启动器的路径 -4. 请注意，全屏模式下的分辨率由显示器分辨率设置决定，游戏内调整没有意义。MAAEND强制要求16:9的分辨率比例 -5. 请不要启用插帧等功能，这有可能引发MAAEND截图失败 +### 代理跑一半失败了 + +先看是不是这几种情况： + +- **代理时你在用电脑**。前台模式会完全占用鼠标，你这时候动键鼠就会打断它。想边用电脑边代理，得改用模拟器。 +- **等待时间被你调短了**。终末地启动本来就慢，别低于默认的 60 秒，游戏没进完就开始操作必然失败。 +- **开了插帧之类的画面增强**。这会让 MaaEnd 截图失败，关掉。 + +### 分辨率要怎么设 + +MaaEnd 强制要求 **16:9** 比例。注意全屏模式下的实际分辨率由你的**显示器设置**决定，在游戏里改分辨率没有意义。 + +### 游戏路径选哪个 exe + +选 `Endfield.exe`，**不要选鹰角启动器**。这是最常见的填错。 diff --git a/docs/script-guide/march7th.md b/docs/script-guide/march7th.md index 20dce16..7d53118 100644 --- a/docs/script-guide/march7th.md +++ b/docs/script-guide/march7th.md @@ -25,10 +25,8 @@ date: 2025-11-08 1. 前往 、 或 下载软件压缩包。 2. 将 三月七小助手 压缩包解压至任意文件夹。 -::: warning 温馨提醒 -请不要将三月七小助手以及其他需要使用的通用脚本解压在中文文件夹，比如**脚本**等等。 - -以便出现不必要的异常。 +::: warning 别解压到中文路径 +三月七小助手（以及其他通用脚本）都不要放在带中文的文件夹里，比如 `D:\脚本\`。中文路径容易引发莫名其妙的报错，用 `D:\M7A` 这样的纯英文路径。 ::: @@ -52,8 +50,8 @@ date: 2025-11-08 5. 在 **打开的脚本配置** 中的 **脚本根目录** 单击 **选择文件夹**，打开 三月七小助手 软件所在目录。 ![AUTO_MAS配置5](/docs/img/script-guide/March7thAssistan/AUTO-MAA-5.png) -::: warning 温馨提示 -脚本配置一栏会在选择脚本根目录以后自动修正，请不要在不理解这个功能有什么作用的时候贸然修改，以便给自己在使用AUTO-MAS的过程中带来不愉快。 +::: warning 下面那些路径别手动改 +选好脚本根目录之后，**脚本配置** 一栏的各个路径会自动填好。模板已经帮你配对了，不清楚每项是什么意思就别动它，改错了代理会各种出问题。 ::: 6. 选择完 三月七小助手 的目录以后会自动修正**脚本配置**一栏的路径，无需手动选择。同时我们需要点击右下方的保存按钮 diff --git a/docs/script-guide/okww.md b/docs/script-guide/okww.md index c68bf4e..86bf176 100644 --- a/docs/script-guide/okww.md +++ b/docs/script-guide/okww.md @@ -64,16 +64,16 @@ AUTO-MAS 的专项适配只接管高频、重复的操作：启动任务、监 - 游戏启动器必须是官方 `launcher.exe`；**不支持 WeGame 资源或 WeGame 启动器**。 - 不使用 MAS 管理游戏启停时，可以关闭 **启用游戏配置**；这不会改变 OK-WW 的官方资源要求。 -## 当前支持的启动任务 +## 目前能跑哪些任务 -MAS 当前只在 OK-WW 专项入口中接管以下任务： +AUTO-MAS 只接管这两个： -| 任务序号 | 启动参数 | 说明 | -| --- | --- | --- | -| 1 | `-t 1 -e` | `DailyTask`，日常任务 | -| 7 | `-t 7 -e` | `MultiAccountDailyTask`，多账号日常任务 | +- **日常任务** +- **多账号日常任务** + +跑完 AUTO-MAS 会让 OK-WW 自己退出，不用你管。 -`-e` 由 MAS 固定追加，表示任务完成后退出 OK-WW。其他 OK-WW 任务请使用 OK-WW 自身入口，不要在 MAS 中按未提供的任务序号运行。 +OK-WW 的其他任务暂时没接，需要的话直接开 OK-WW 自己跑。 ## 常见问题 diff --git a/docs/script-guide/sra.md b/docs/script-guide/sra.md index 4d15fce..c50a7da 100644 --- a/docs/script-guide/sra.md +++ b/docs/script-guide/sra.md @@ -23,18 +23,23 @@ StarRailAssistant是一个崩坏星穹铁道的第三方软件，能够轻松完 1. 前往 、 或 下载软件压缩包。 2. 将 SRA 压缩包解压至任意文件夹。 -::: warning 温馨提醒 -请不要将SRA以及其他需要使用的通用脚本解压在中文文件夹，比如**脚本**等等。 - -以便出现不必要的异常。 +::: warning 别解压到中文路径 +SRA（以及其他通用脚本）都不要放在带中文的文件夹里，比如 `D:\脚本\`。中文路径容易引发莫名其妙的报错，用 `D:\SRA` 这样的纯英文路径。 ::: ## 设置脚本实例 -由于 SRA 和 AUTO-MAS 都提供了多用户功能，因此在 AUTO-MAS 中调度 SRA 有两种方式： +SRA 自己能管多账号，AUTO-MAS 也能管多账号，所以这里有两条路可走。**先选一条，别两边都配**： + +| | 谁来管账号 | 适合 | +| --- | --- | --- | +| **方式一** | AUTO-MAS 管 | 想在 AUTO-MAS 里看到每个号的代理结果、单独启停某个号 | +| **方式二** | SRA 管 | 已经在 SRA 里配好多个账号了，不想重新配一遍 | + +两种方式的区别见页面底部的[对比图](#差异)。 -### 方式一：基于AUTO-MAS的多用户功能 +### 方式一：用 AUTO-MAS 的多用户功能 1. 打开 **AUTO-MAS**，进入 **脚本管理**，单击 **新建脚本** 并选择 **通用脚本** 以添加脚本实例管理页面。 ![SRA配置1](/docs/img/script-guide/March7thAssistan/AUTO-MAA-1.png) @@ -45,8 +50,8 @@ StarRailAssistant是一个崩坏星穹铁道的第三方软件，能够轻松完 ![SRA配置3](/docs/img/script-guide/sra/mas1.png) 5. 在 **打开的脚本配置** 中的 **脚本根目录** 单击 **选择文件夹**，打开 SRA 软件所在目录。 ![SRA配置4](/docs/img/script-guide/sra/mas2.png) - ::: warning 温馨提示 - 脚本配置一栏会在选择脚本根目录以后自动修正，请不要在不理解这个功能有什么作用的时候贸然修改，以便给自己在使用AUTO-MAS的过程中带来不愉快。 + ::: warning 下面那些路径别手动改 + 选好脚本根目录之后，**脚本配置** 一栏的各个路径会自动填好。模板已经帮你配对了，不清楚每项是什么意思就别动它，改错了代理会各种出问题。 ::: 6. 选择完 SRA 的目录以后会自动修正**脚本配置**一栏的路径，无需手动选择。 ![SRA配置5](/docs/img/script-guide/sra/mas3.png) @@ -55,25 +60,25 @@ StarRailAssistant是一个崩坏星穹铁道的第三方软件，能够轻松完 8. 脚本配置将自动保存，接下来退出脚本配置页面。 9. 点击**添加用户**，需要自己给添加的用户进行命名（在用户名一栏输入你想要的用户名（这仅仅只是个命名而已）），然后点击右上方的**通用配置**按钮 ![SRA配置7](/docs/img/script-guide/sra/mas5.png) -10. 这将启动 SRA 窗口，用户可以在此界面中进行 SRA 的相关配置。 - ::: warning 温馨提示 - 使用基于AUTO-MAS的多用户功能时，请勿修改配置文件名称，保持配置文件名称为默认的 `Default` +10. 这会启动 SRA 窗口，在里面配置 SRA 本身。 + ::: warning 配置文件名保持 Default + 用 AUTO-MAS 管多用户时，不要改配置文件名，保持默认的 `Default`。 ::: ![SRA配置8](/docs/img/script-guide/sra/sra1.png) 11. 配置完成后，点击SRA窗口主页启动按钮右侧的箭头，展开启动选项，选择**仅保存配置** ![SRA配置9](/docs/img/script-guide/sra/sra2.png) 12. 点击**仅保存配置**后，关闭 SRA 窗口并点击 AUTO-MAS 中的保存配置按钮，就完成了一个用户的配置。 ![SRA配置10](/docs/img/script-guide/sra/sra3.png) -13. 如果要添加更多用户，请重复步骤 8-12，您可能注意到当第10步启动 SRA 窗口时，SRA 会自动加载上一次的配置文件，这是正常现象，您只需为新用户修改配置即可。 - ::: warning 温馨提示 - 使用基于AUTO-MAS的多用户功能时，请勿修改配置文件名称，保持配置文件名称为默认的 `Default` +13. 要加更多用户就重复步骤 9-12。第 10 步启动 SRA 时，它会自动载入上一次的配置，这是正常的，你只要改成新用户的设置就行。 + ::: warning 每个用户都一样 + 配置文件名统一保持默认的 `Default`，不要改。 ::: -### 方式二：基于SRA的多用户功能 +### 方式二：用 SRA 的多用户功能 -步骤1-7与方式一相同。 +前 7 步和方式一一样，从第 8 步开始不同。 -8. 修改启动参数一栏，改为 `-e task run`，这将使 SRA 在启动时运行所有配置，而不是单独运行某个配置文件。 +8. 把 **启动参数** 改成 `-e task run`。这样 SRA 启动后会把它自己保存的所有配置跑一遍，而不是只跑某一个。 ![修改启动参数](/docs/img/script-guide/sra/mas6.png) 9. 配置将自动保存，接下来退出脚本配置页面。 10. 点击**添加用户**，需要自己给添加的用户进行命名（在用户名一栏输入你想要的用户名（这仅仅只是个命名而已）)，然后点击右上方的**通用配置**按钮 @@ -89,5 +94,8 @@ StarRailAssistant是一个崩坏星穹铁道的第三方软件，能够轻松完 ### 差异 -下面的图片展示了两种方式的逻辑差异： -![对比](/docs/img/script-guide/sra/compare.png) \ No newline at end of file +两种方式的区别一图说明： + +![对比](/docs/img/script-guide/sra/compare.png) + +简单说：方式一是 AUTO-MAS 每次换上一个用户的配置、启动 SRA 跑一轮；方式二是 AUTO-MAS 只启动 SRA 一次，由 SRA 自己把所有配置跑完。 \ No newline at end of file diff --git a/docs/task-scheduler.md b/docs/task-scheduler.md index 4fcc001..d0ce48d 100644 --- a/docs/task-scheduler.md +++ b/docs/task-scheduler.md @@ -2,59 +2,47 @@ ## 调度队列 -**调度队列** 是 AUTO-MAS 组织各脚本任务的模块，它能设定 **多个脚本** 的运行顺序，配置启动软件时自动运行任务与定时自动运行任务。 +**调度队列** 就是一张待办清单：你把要跑的脚本按顺序放进去，AUTO-MAS 按清单从上到下一个一个跑完。你还可以让它在软件启动时自动开跑，或者到点自动开跑。 -::: warning 温馨提醒 -调度队列功能为脚本串联运行也就是完成一个脚本后才会运行下一个脚本， +::: warning 先搞清楚这两件事 +**队列里的脚本是排队跑的**，前一个跑完才轮到下一个。如果你发现几个脚本挤在一起同时跑了，去检查通用脚本设置。 -如果出现单个队列脚本并联运行的时候请检查通用脚本设置 - -同一队列的时间设置不同启动时间并不是和脚本一一对应的启动时间， - -运行队列会同时运行该队列的所有脚本。 - -如果确定要使用，请仔细并认真阅读本文档后再进行提问。 +**一个队列可以设多个定时时间，但这些时间不是分配给单个脚本的。** 每到一个时间点，整个队列都会从头跑一遍，而不是"这个点跑脚本 A，那个点跑脚本 B"。 ::: ![scheduler](/docs/img/advanced-features/scheduler.png) ### 用法 -1. 点击右上角的新建队列，创造一个新队列。 -2. 根据你的需求，选择打开 **启动时运行**、**定时运行**。 - -::: tip 小技巧 -你可以将 AUTO-MAS 设为开机启动，并在调度队列勾选启动时运行，这样在你启动电脑时可以无感代理模拟器的脚本（如 MAA）。 - -如果你有一台永不停歇的核动力电脑，你可以设定定时运行，AUTO-MAS 会在你选择的时间进行自动代理。 +1. 点右上角 **新建队列**。 +2. 按需要打开 **启动时运行** 或 **定时运行**。 +3. 点 **添加定时** 设好时间，**记得把定时运行的状态改成启用**，不然不会触发。 +4. 点 **添加任务**，把已配好的脚本加进队列。如果这里没有可选的东西，说明你还没配脚本，先看 [脚本配置](/docs/script-guide/)。 -如果你有特殊的上号需求（例如 MAA 自定义基建），你可以在 MAA 的自定义基建生效前一段时间自动启动 MAA，让 MAA 执行基建切换。 +::: tip 三种常见玩法 +- **开机就代理**：把 AUTO-MAS 设为开机启动，队列勾上 **启动时运行**，开机后自动跑完，你什么都不用管。 +- **到点就代理**：电脑常年不关机的话，用 **定时运行** 挑几个时间点让它自己跑。 +- **配合 MAA 自定义基建**：在基建方案切换生效前一小会儿定时启动 MAA，让 MAA 顺手把班也换了。 ::: -3. 点击添加定时，设定你需要运行脚本的时间，设置此项时 **别忘了将定时运行状态改为启用** -4. 添加任务，此处的 **任务** 为 **脚本管理** 内已经配置好的脚本任务，若没有可选的任务，请查阅 [脚本配置](/docs/script-guide/) +## 自动代理时的执行顺序 +**自动代理** 模式下，任务是这样一层层展开的： -## 自动代理策略 - -以下为 **自动代理** 模式下，AUTO-MAS 的任务调度策略。 - -- 每个 **用户** 包含 **剿灭任务**、**日常任务** 两个子任务。简洁模式下 **日常任务** 默认开启。软件不检查用户是否存在同时运行情况。调度顺序：**剿灭 > 日常**。*此条仅适用于 MAA 脚本* -- 每个 **脚本实例** 包含若干用户。一个 **脚本实例任务** 即为其 **下属用户** 所有任务的总和。同一 **脚本实例** 无法被重复启动，若已在运行，新 **脚本实例任务** 将被跳过。调度顺序：**用户序号升序**。 -- 每个 **调度队列** 包含若干 **脚本实例任务**。一个 **调度队列任务** 即为其 **任务队列** 中所有 **脚本实例任务** 的总和。同一 **调度队列** 可以被重复启动。调度顺序：**任务实例序号升序**。 -- 每个 **调度台** 可以运行并展示一个 **调度队列任务**，可以通过创建多个 **调度台** 来实现多开。 +- **一个用户** = 该用户勾选的所有任务。MAA 脚本的用户分 **剿灭** 和 **日常** 两块，先剿灭后日常；简洁模式默认开日常。 +- **一个脚本** = 它下面所有用户的任务，按用户在列表里的顺序往下跑。同一个脚本不能同时跑两遍——已经在跑的话，重复启动会被跳过。 +- **一个队列** = 队列里所有脚本的任务，按队列里的顺序往下跑。同一个队列可以重复启动。 +- **一个调度台** 同时只跑一个队列。想并行跑多个队列，就多开几个调度台。 ## 人工排查 -**人工排查** 是用于检查用户代理情况的模式，可以依次排查各用户代理情况，并记录排查结果。 - -::: info 帮帮我，开发者先生 - -目前只支持MAA，未来可期 +代理跑完了，但你想亲眼确认每个号到底有没有做完？用 **人工排查**：AUTO-MAS 帮你逐个登号，你负责看一眼，它负责记账。 +::: info 目前只支持 MAA +其他脚本暂未适配。 ::: -- 选择 **人工排查模式**，点击 **开始任务**。 -- 软件将启动 MAA，依次登录各用户账号。 -- **完成 PRTS 登录后**，人工检查代理情况，并手动确认未执行的任务。 -- 结束排查后，系统会记录结果至 **用户管理页的状态信息栏目**。 \ No newline at end of file +1. 选择 **人工排查模式**，点 **开始任务**。 +2. 软件启动 MAA，依次登录各个账号。 +3. **每次 PRTS 登录完成后**，你自己看一眼这个号的代理情况，把没做完的任务手动确认掉。 +4. 排查结束后，结果会记到 **用户管理页的状态信息** 里。 \ No newline at end of file diff --git a/docs/user-guide.md b/docs/user-guide.md index fae8280..f6ad5c6 100644 --- a/docs/user-guide.md +++ b/docs/user-guide.md @@ -1,38 +1,39 @@ # 开始使用 -## 前置信息 +## 什么是 AUTO-MAS？ -### 什么是 AUTO-MAS？ +AUTO-MAS 是一个"脚本的总管"。你原本要一个个手动开的脚本（比如 MAA），交给它统一安排：它替你切换账号配置、按顺序启动脚本、盯着脚本日志判断跑成功还是卡住了。 -**AUTO-MAS** 是基于日志监看的多脚本多配置管理与自动化软件。通过修改配置文件和监听日志，控制其他脚本程序（如 MAA） 完成多账号代理。 +也就是说，你要的多账号代理，它一次帮你全跑完。 > AUTO-MAS: Make ALL Scripts Auto -## 使用方法 +## 安装 -### 安装 AUTO-MAS +### 下载并安装 1. 前往 [下载页](/download/auto-mas) 获取最新版本安装包。 2. 按照安装包类型完成安装操作： - 安装版：解压压缩包并双击运行 `AUTO-MAS-Setup.exe`，根据安装指引完成安装。 - 便携版：将压缩包解压至安装位置，完成解压后可以通过运行 `AUTO-MAS.exe` 启动程序。 -::: tip 如何选择安装包 +::: tip 文件名里的这些词是什么意思 -部分下载渠道允许用户自行选择安装包类型，您可以参考以下指南选择。 +有的下载渠道会给出好几个安装包，按文件名挑就行： -- **安装版与便携版** - - 带有 `setup` 标识的安装包为安装版，可以通过直接运行安装程序完成安装。 - - 无 `setup` 标识的安装包为便携版，可以通过直接解压到安装位置完成安装。 - -- **完整包与精简包**。 - - 带有 `full` 标识的安装包为完整包，已包含大部分依赖项，初次启动较快。 - - 带有 `lite` 标识的安装包为精简包，不包含依赖项，初次启动时将自动下载安装依赖项。 +| 文件名带 | 意思 | 什么时候选 | +| --- | --- | --- | +| `setup` | 安装版，运行安装程序 | 想让安装程序帮你处理好安装位置等事项 | +| 没有 `setup` | 便携版，解压即用 | 想自己决定装在哪，或者以后整个文件夹搬走 | +| `full` | 依赖已经打包在里面 | 网络不好，不想在首次启动时等下载 | +| `lite` | 首次启动时再下载依赖 | 想少下点东西 | ::: -### 为软件添加信任 +### 加入杀软白名单（很重要，别跳过） -运行软件前，请将 `AUTO-MAS 安装目录`、`脚本软件安装目录` 添加入 Windows Defender 排除项以及防病毒软件的信任区或开发者目录，避免被误杀。以下展示 **添加 Windows Defender 排除项** 方法： +自动化脚本会频繁模拟点击、读写配置，杀软很容易把它当病毒删掉。所以第一次运行前，请把 `AUTO-MAS 安装目录` 和 `各脚本的安装目录` 都加进 Windows Defender 排除项，装了第三方杀软的也一并加到信任区。 + +下面是 **添加 Windows Defender 排除项** 的步骤： 快速链接： @@ -52,21 +53,21 @@ *这总不需要示意图了吧* -::: warning 注意 -即使已经安装其它杀毒软件（如：**火绒**、**360 极速版**），**Windows Defender** 防病毒功能仍可能会不定时开启，这可能导致您的`AUTO-MAS.exe` 或其他脚本可执行文件突然消失。因此，您必须确保以上目录被 **Windows Defender** 排除。 +::: warning 装了火绒/360 也一样要做这一步 +即使你已经装了别的杀软，**Windows Defender** 的实时防护仍可能自己开起来，然后你的 `AUTO-MAS.exe` 或某个脚本的 exe 就无声无息地消失了。所以上面这些目录必须在 Defender 里排除掉。 ::: -## 初始化 +## 第一次启动 -AUTO-MAS 启动时，会自动初始化软件依赖项，并更新后端代码。 +第一次打开 AUTO-MAS 会花一点时间：它在下载运行需要的依赖，并把后端代码更新到最新。耐心等它跑完。 -此后若打开 `设置 -> 更新配置 -> 自动检查更新` 功能，每一次启动软件时，都会自动检查依赖项并更新后端。 +之后如果开着 `设置 -> 更新配置 -> 自动检查更新`，每次启动都会顺手检查一遍。修复通常先从后端推送，所以**遇到问题时，重启一次软件往往就已经修好了**，值得先试。 -通过后端代码更新，AUTO-MAS 实现了部分问题修复的快速推送。通过重启软件，您可以第一时间获取问题修复。 +## 接下来配置什么 -## 配置软件 +软件里几乎每个设置项都写了说明，把每个页面从上到下过一遍，基本就配完了。卡住了再回文档找对应章节。 -AUTO-MAS 已经对大部分页面进行了注释，您可以直接阅读软件内的提示进行配置，所有页面全部过一遍后，您大概率就完成所有配置，若遇到配置问题，欢迎回来继续查看对应文档内容。 +两件事记一下，出问题时用得上： -- **备份配置**：AUTO-MAS 将配置文件保存在软件安装根目录下的 `data`、`config` 文件夹中，将历史记录保存在 `history` 文件夹中，您可以通过备份这些文件来恢复软件配置数据。 -- **运行日志**：AUTO-MAS 将后端日志保存在软件安装根目录下的 `debug/app.log` 文件中，将前端日志保存在 `debug/frontend.log` 文件中，您可以通过提供这些日志文件来让开发者快速定位问题。 \ No newline at end of file +- **想备份/迁移配置**：拷走安装目录下的 `data`、`config`（配置）和 `history`（历史记录）三个文件夹就够了。 +- **要找开发者报错**：日志在安装目录的 `debug/app.log`（后端）和 `debug/frontend.log`（界面），提问时带上这两个文件，能省掉一轮来回。 \ No newline at end of file diff --git a/en/docs/FAQ.md b/en/docs/FAQ.md index f5ec9f3..e350f85 100644 --- a/en/docs/FAQ.md +++ b/en/docs/FAQ.md @@ -1,99 +1,92 @@ # FAQ -For more issues, see . +If your question isn't here, have a look through . -For script-specific issues, read the script documentation or contact the script developers. +If the problem is in the script itself (MAA failing to recognize a stage, for example), that's the script's business. Check that script's documentation or ask its author. AUTO-MAS only schedules them. ## Questions -### Does AUTO-MAS benefit paid account runners? +### **Does AUTO-MAS benefit paid account runners?** - When paid account runners use AUTO-MAS, it benefits paid account runners. When regular users use AUTO-MAS, it benefits regular users. -- The wider AUTO-MAS spreads, the more it benefits users. Consider helping promote AUTO-MAS. +- And the wider AUTO-MAS spreads, the more it benefits users, so go help spread the word. -### Is my data, such as account passwords, safe? +### Are my account passwords safe? -To keep sensitive information, such as login credentials and access tokens, stored securely on your local machine, AUTO-MAS uses the **Windows Data Protection API (DPAPI)**. +Yes. The passwords and tokens you enter are encrypted with Windows' own encryption (DPAPI) and stored on your machine. AUTO-MAS never uploads them to any server. -**DPAPI** is a Windows mechanism for encrypting and decrypting sensitive local data. Its master key is derived from the user's login password or system startup key and protected by the operating system kernel, so it is not exposed to applications in plaintext. This means: +That encryption is tied to your Windows login account, which means: -- Only you can decrypt the data when logged in to your **Windows account**. -- Even if someone copies your configuration files, they cannot decrypt the data on another computer or account. -- Encryption, decryption, and key management are handled by Windows automatically. +- The app can only decrypt the data while you are signed in to that Windows account on that computer. +- Even if someone copies the whole config folder, they can't decrypt it on another computer. -::: warning Warning -Existing data may fail to decrypt in the following cases: +::: warning The tradeoff: change environments and it can't be decrypted +In the three cases below, your old credential data stops working and you'll have to enter it again. This is not a bug: -1. **Changing or reinstalling the system** - If you reinstall Windows or use a new computer account, the encryption key from the original account is lost and the app cannot read old data. -2. **Deleting or resetting the user account password** - DPAPI encryption keys are bound to your Windows login credentials. - If you reset the password abnormally, such as through offline modification or system repair tools, Windows cannot decrypt old encrypted files. -3. **Copying data to another computer or account** - DPAPI-encrypted data is valid only on the original account and computer. Data copied to another environment cannot be decrypted if the key does not match. +1. **You reinstalled Windows, or switched to a new Windows account** — the key from the old account is gone. +2. **You reset your Windows login password by bypassing Windows** (offline password editors, system repair tools, and the like) — changing your password normally from inside Windows is fine; going around Windows to do it loses the key. +3. **You copied the configuration to another computer or another Windows account** — the encrypted data is only valid under the original account on the original computer. ::: ## Troubleshooting -### Backend startup fails, then the app keeps reporting Network Error +### The app keeps showing Network Error -Check the frontend error page or open `debug/app.log` for the error details. +That means the backend didn't start. First find the actual error, either on the error page in the app or in `debug/app.log`, then match it against the list below: -- **[Errno 10048] error while attempting to bind on address ('0.0.0.0', 36163): Only one usage of each socket address is normally permitted.** +- **`[Errno 10048] error while attempting to bind on address ('0.0.0.0', 36163)`** - **The port is occupied.** The default AUTO-MAS backend port is `36163`. Check whether the port is already in use. + Another program has taken the port. The AUTO-MAS backend uses port `36163`. Find what's holding it and close that. -- **ModuleNotFoundError: No module named 'xxx'** +- **`ModuleNotFoundError: No module named 'xxx'`** - **A dependency is missing.** Delete `environment/.requirements_hash` under the app root and restart the app. If the issue remains, delete the `environment` folder and restart the app. + Dependencies are incomplete. Delete `environment/.requirements_hash` in the install directory and restart the app so it reinstalls them. If that doesn't help, delete the whole `environment` folder and restart. -- **ImportError: DLL load failed while importing onnxruntime_pybind11_state: A dynamic link library (DLL) initialization routine failed.** +- **`ImportError: DLL load failed while importing onnxruntime_pybind11_state`** - **A system runtime is missing.** AUTO-MAS depends on the **Microsoft Visual C++** runtime. If it is missing, download and install it from [Microsoft Visual C++](https://learn.microsoft.com/en-us/cpp/windows/latest-supported-vc-redist?view=msvc-170#latest-supported-redistributable-version) or directly from [Microsoft Visual C++ x64](https://aka.ms/vc14/vc_redist.x64.exe). + Your system is missing the **Microsoft Visual C++** runtime. Installing it fixes this: [download the x64 build directly](https://aka.ms/vc14/vc_redist.x64.exe), or pick a version from the [Microsoft page](https://learn.microsoft.com/en-us/cpp/windows/latest-supported-vc-redist?view=msvc-170#latest-supported-redistributable-version). -::: tip Note +::: tip When neither the error page nor the log shows an error -If neither the frontend error page nor the log file shows an error, run a terminal, PowerShell, or CMD as administrator and execute: +Run the backend by hand to force the error out. Open a terminal (PowerShell or CMD) as administrator and run: ```bash cd {AUTO-MAS root directory} .\environment\python\python.exe main.py ``` -Replace `{AUTO-MAS root directory}` with the AUTO-MAS installation directory. - -The terminal will print error logs that can be used for troubleshooting. +Replace `{AUTO-MAS root directory}` with your actual install path. Whatever the terminal prints is your lead. ::: -### Emulator startup fails +### The emulator fails to start -- All scripts and apps started by AUTO-MAS run with **administrator privileges**. When emulator multi-instance mode is used, some emulator instances may not have administrator privileges and therefore cannot start new emulator instances with administrator privileges. Make sure all current emulator instances and the emulator multi-instance manager are running as administrator: +This is almost always mismatched privileges. Everything AUTO-MAS launches runs as administrator, but if an emulator instance is already open without administrator rights, a new instance can no longer be started as administrator. So **one instance opened with normal privileges is enough to break every additional instance after it**. - 1. Close all emulator instances and the emulator multi-instance manager. - 2. Restart the task in AUTO-MAS and check whether it runs normally. If it still fails, restart the computer and start the task directly from AUTO-MAS. - 3. When using the emulator or its multi-instance manager later, **right-click > Run as administrator**. For convenience, you can create a shortcut and enable **Right-click > Properties > Shortcut > Advanced > Run as administrator**. +1. Close every emulator instance and the multi-instance manager. +2. Go back to AUTO-MAS and start the task again. If it still fails, restart the computer and start it straight from AUTO-MAS, without opening the emulator by hand in between. +3. From then on, when you open the emulator or the multi-instance manager yourself, use **right-click > Run as administrator**. If that gets tedious, make a shortcut and set **right-click > Properties > Shortcut > Advanced > Run as administrator**, so double-clicking it always runs as administrator. -### Why can't AUTO-MAS open the MAA settings window? +### I clicked configure MAA, but the MAA window never appeared -- If **minimize MAA immediately after startup** and **hide to tray when minimized** are enabled in MAA, find MAA in the tray area and continue configuring it there. If this is too time-consuming, try enabling **silent mode**. +MAA has probably hidden itself in the tray. If you enabled **minimize immediately after startup** plus **hide to tray when minimized** in MAA, this is what happens. Find it in the tray at the bottom right and click it to keep configuring. If that gets old, switch to **silent mode**. -### Script configuration reports: the main program must be a subpath of the script root directory +### Error: the main program must be a subpath of the script root directory -- Check whether the **script root directory** option is correct. You must set this value before setting paths such as the main program path. +The **script root directory** is unset or wrong. Every other path is measured from it, so you have to set it correctly before you can set the main program path. -### How do I safely save MAA settings? +### How do I know MAA's settings actually saved? -- Configure MAA in AUTO-MAS and click **Save configuration** after finishing. +Open MAA from inside AUTO-MAS, configure it, then come back to AUTO-MAS and click **Save configuration**. Settings you change by opening MAA directly, bypassing AUTO-MAS, are not recorded. -### The emulator still does not minimize automatically after silent mode is enabled +### Silent mode is on but the emulator doesn't minimize -- Check whether the emulator boss key is configured correctly and whether there are key conflicts. +Check that the emulator's **boss key** is set correctly, and that no other software has claimed that key combination. -### Why did the scheduling queue not run automatically? +### The scheduling queue didn't run at its scheduled time -- Confirm that **Scheduled run** is **enabled** for the scheduling queue and that the app has not been closed unexpectedly. AUTO-MAS cannot run during sleep or hibernation. +Two things to check: whether **Scheduled run** is actually enabled, and whether the app was closed or the computer went to sleep or hibernation (see below). -### Can AUTO-MAS run during sleep or hibernation? +### Can it run while the computer is asleep or hibernating? -- **No.** Known scripts do not support running during sleep or hibernation. +**No.** Sleep and hibernation stop the program entirely, and no current script supports being used that way. For scheduled runs, the computer has to stay awake. diff --git a/en/docs/advanced-features/emulator.md b/en/docs/advanced-features/emulator.md index ac58235..e63b9c3 100644 --- a/en/docs/advanced-features/emulator.md +++ b/en/docs/advanced-features/emulator.md @@ -1,49 +1,35 @@ # Emulator Management -Emulator management is a distinctive MAS feature. It is designed to solve common bugs caused by emulator behavior and emulator adaptation once and for all. +Register your emulator here once and AUTO-MAS fills in the emulator settings for every script, so you do not have to match them up script by script. That usually clears up the old problems with multi-instance setups and failed connections. -![emulator management](/docs/img/advanced-features/emulator-1.png) - -*The screenshot shows example content. It will look like this only after configuration.* - -## Search for Emulators - -During initial configuration, you can use automatic search or manual search. If you use automatic multi-instance manager search, one click is enough. +Put plainly, it is a multi-instance manager: it queries the emulator over the command line for instance details (port, instance number, and so on) and fills them into each script's config automatically. -MAS automatically searches for emulators installed under their **default installation paths**. - -If you changed the default path, MAS cannot find the emulator automatically and you need to add it manually. +![emulator management](/docs/img/advanced-features/emulator-1.png) -First, understand the configuration fields. +*The screenshot shows example content. You need to configure it yourself.* -## Configuration Explanation +## Adding an Emulator -**Emulator name**: a display name used only inside MAS. +Just use automatic search. AUTO-MAS scans the **default installation paths**. -**Emulator type**: the emulator software name, such as MuMu emulator or LDPlayer. Select it from the dropdown. +If you changed the install location when you set up the emulator, automatic search will not find it and you have to add it manually. -::: tip Best Practice +## Filling In the Settings -AUTO-MAS strongly recommends MuMu 12 or LDPlayer because they have good performance, reliable screenshots, and mature multi-instance manager support. If you are installing an emulator from scratch, consider one of them. +| Setting | What to enter | +| --- | --- | +| **Emulator name** | Anything you like. It is only shown to you inside AUTO-MAS | +| **Emulator type** | Pick which emulator you use from the dropdown, such as MuMu or LDPlayer | +| **Emulator path** | Select the **multi-instance manager**, not the emulator's main program | +| **Maximum wait time** | How long to wait for the emulator to start. The script only launches once the emulator is up, so raise this on a slow machine | +| **Boss key** | In silent mode, AUTO-MAS presses this key to hide the emulator | +::: tip Common multi-instance manager paths +- MuMu 12 v4: `MuMu installation directory\shell\MuMuManager.exe` +- MuMu 12 v5: `MuMu installation directory\nx_main\MuMuManager.exe` +- LDPlayer: `LDPlayer installation directory\LDPlayer9\dnplayer.exe` ::: -**Emulator path**: the directory of the emulator **multi-instance manager** for the corresponding software. - -::: tip Common Emulator Paths - -MuMu 12 v4: `MuMu installation directory\shell\MuMuManager.exe` - -MuMu 12 v5: `MuMu installation directory\nx_main\MuMuManager.exe` - -LDPlayer: `LDPlayer installation directory\LDPlayer9\dnplayer.exe` - +::: tip No emulator yet? Pick MuMu 12 or LDPlayer +Both perform well and capture screenshots reliably, and their multi-instance manager support is the most complete, so AUTO-MAS works best with them. Other emulators may land you on problems nobody has hit before. ::: - -**Maximum wait time**: how long AUTO-MAS waits for the emulator to start when a script uses this emulator. The script program starts only after the emulator starts. - -**Boss key**: pressed automatically when silent mode is used. - -## Notes - -Emulator management is essentially a multi-instance manager integration. AUTO-MAS uses a series of command-line commands to obtain emulator information and then fills the corresponding script configuration fields automatically. diff --git a/en/docs/advanced-features/game-sign.md b/en/docs/advanced-features/game-sign.md new file mode 100644 index 0000000..70b170b --- /dev/null +++ b/en/docs/advanced-features/game-sign.md @@ -0,0 +1,162 @@ +# Game Check-in Tool + +Opening each community app every day to tap the check-in button gets old. Fill in your credentials here once, and your automation runs will handle check-ins along the way. + +Four communities are supported: **Skland**, **miyoushe**, **Kuro Community**, and **Tajiduo**. You don't have to tell it which characters you have — it reads the game characters bound to your account, checks in for each one, and lists every character's status in the results. + +::: warning Read This Before You Start + +- Check-in requests are made locally by AUTO-MAS. Tokens are only used to reach the official API of the matching community, and are not sent to third-party services unrelated to check-in. +- A token is a login credential. Don't send it to anyone, and don't put it in public logs, screenshots, or config repositories. +- **Get token with account and password** uses your account and password only inside that one login request. Neither is saved: the input is cleared when the request finishes or fails, and nothing is written to config, logs, or notifications. +- AUTO-MAS does not offer SMS-code login. When you use a password or a QR code to obtain credentials, make sure your network and your account are in a safe state. +- Automatic check-in carries risks: account risk control, API changes, and failed check-ins. Evaluate that yourself and accept the consequences of using it. + +::: + +## Basic Usage + +1. Open the **Game Community Check-in** tool in AUTO-MAS. +2. Set **Enable check-in** to **Enabled** at the top. +3. Edit the community credentials for each user. One user can have several communities configured at once. +4. Turn on **Notify after check-in** and **Check in on startup** if you want them. +5. Click **Check in all** to run a check-in immediately by hand. + +The community tags in the user list show which communities are configured and the most recent result. Hover over a tag for details such as character, game, status, and rewards. + +### Three Ways It Triggers + +| When it runs | How often per day | How the notification is sent | +| --- | --- | --- | +| **Along with an automation task** | One attempt per account per day; once done, no repeat requests | Folded into the task completion notification | +| **When the app starts** | Once per startup | Sent as its own notification | +| **When you click Check in all** | Any time, not limited by "already checked in today" | Sent as its own notification | + +::: tip You clicked Check in all and it told you to retry later +An automatic check-in is running right now. Wait for it to finish, then click again. +::: + +Communities you haven't given credentials to won't appear in the notification, so you won't see a pile of empty entries. + +## Skland + +Skland check-in automatically looks up the **Arknights** and **Arknights: Endfield** characters under your Hypergryph account. Each character's check-in status is recorded separately. + +### Get a Token From the Web + +1. Log in to [Skland on the web](https://www.skland.com/). +2. In the same browser session, open the [Hypergryph account credential endpoint](https://web-api.skland.com/account/info/hg). +3. Find `data.content` in the JSON that comes back and copy **only that field's value**: + + ```json + { + "code": 0, + "data": { + "content": "" + } + } + ``` + +4. Paste the token into the **Skland** field in the user edit window and save. + +Don't copy the outer JSON, the quotation marks around `content`, or any other field. To switch accounts, clear your browser cookies and log in again — logging out on the web page directly can invalidate the original credential. + +### Get a Token With Your Password + +1. Click **Get token with account and password** in the **Skland** section of the user edit window. +2. Enter your Hypergryph account phone number and password in the separate popup window. +3. On success, AUTO-MAS validates the returned credential and saves it automatically. A failed login does not overwrite an existing token. + +Your account and password only exist in memory for that one request. The input is cleared when the window closes and on both success and failure. This feature does not offer SMS-code login. + +## miyoushe + +miyoushe automatically reads the characters bound to your account across **Genshin Impact, Honkai: Star Rail, Zenless Zone Zero, Houkai Gakuen 2, Honkai Impact 3rd, and Tears of Themis**, then checks the check-in status for each one. + +### Recommended: Get a Token by QR Code + +1. Click **Get token by QR code** in the **miyoushe** section of the user edit window. +2. Scan the QR code with the miyoushe app and confirm the login. +3. The credential saves to the current user automatically once you confirm. + +QR codes expire. If you see "QR code expired" or "QR code status invalid", click **Regenerate QR code** and scan again. Scanning obtains an authentication cookie; AUTO-MAS does not write that cookie to the frontend log. + +### Filling In a Cookie by Hand + +You can also run `document.cookie` in the developer tools of a logged-in miyoushe web session and paste the cookie string containing the authentication fields into the input. Don't paste page HTML, a full API response, or unrelated cookies. Without authentication fields such as `cookie_token` and `stoken`, the character lookup and check-in that follow may fail. + +## Kuro Community + +Reads the **Punishing: Gray Raven** and **Wuthering Waves** characters you have bound, and checks in for each one. + +### Get a Token + +This is the awkward one: **there is no web page or QR code option**. The token has to be dug out of the client's local login data, and where it lives changes with the client version and your system, so there is no single set of steps to give you here. + +1. Log in to the account you want to check in with, using the Kuro Community client. +2. Find the token in the local login data. +3. Paste it into the **Kuro Community** field in the user edit window and save. + +For step 2, the open-source project [Kuro_login](https://github.com/mxyooR/Kuro_login) shows one approach. + +::: warning That's a Third-Party Project, Not an Official AUTO-MAS One +Read its code and satisfy yourself that the source is trustworthy before using it. Handing login credentials to any third-party tool carries risk that you take on yourself. AUTO-MAS neither asks for nor receives that project's account credentials. +::: + +If the account has no characters bound that can be checked in, no Kuro Community entry appears in the results. An expired token shows the reason for the failure in the results. + +## Tajiduo + +Looks up the game characters on your account and checks in. + +One thing worth knowing: if you also want to see your remaining Cloud NTE time, that credential **goes in together with the Tajiduo credential**. It isn't a separate login, so don't go looking for its own entry point. + +### Get a Token With Your Password + +1. Click **Get token with account and password** in the **Tajiduo / Cloud NTE** section of the user edit window. +2. Enter your Tajiduo account or phone number and password in the separate popup window. +3. On success, AUTO-MAS validates `accessToken`, `refreshToken`, and the user ID, then saves the credential automatically. + +If the login fails, the returned fields are incomplete, or risk control kicks in, you won't get a "token saved" confirmation and your existing credential won't be overwritten. Your account and password only exist inside that one login request and are cleared afterwards. This feature does not offer SMS-code login or unverified QR-code login. + +### Filling In Credentials by Hand + +The input accepts either of these: + +- Just a `refreshToken`. +- A credential JSON, which may contain `accessToken`, `refreshToken`, `uid`, `deviceId`, `roleName`, and similar fields. + +If you're configuring Cloud NTE as well, add `cloudToken`, `cloudUserId`, and optionally `cloudDeviceId` to the JSON. When credentials refresh, AUTO-MAS updates the saved token during the check-in run, so you don't have to log in again every day. + +## Reading the Results + +| Status | What it means | What to do | +| --- | --- | --- | +| Success | This request completed the check-in | Nothing | +| Already checked in | Already done earlier today; nothing claimed twice | Nothing, this is normal | +| Failed | The request failed, the credential expired, or character info couldn't be read | Get a new token | +| Risk control | The community wants extra verification, or is refusing requests for now | Try again later; don't retry repeatedly | + +Results are shown as community + game + character name. Communities without a token don't take up space, so you won't see empty `0/0` entries. + +## Common Questions + +### The token expired, or check-in keeps failing + +First confirm the account can still log in normally in the official client or on the web. If even the official login fails, the problem isn't AUTO-MAS. If it works, get a fresh token: + +- **miyoushe**: scan the QR code again, that's the easiest. +- **Skland, Tajiduo**: reopen their respective password windows. +- **Kuro Community**: dig it out of the client again. + +### One of my games isn't in the results + +The tool only handles the **bound characters** the community API reports. Confirm that game really is bound to this community account, then click **Check in all** again. + +### The login failed but it says the token was saved + +That shouldn't happen — a password login has to pass validation before anything is written to config, and a failure saves nothing. If you do hit it, look at the error shown in the interface and report it to the developers. + +::: warning Don't Post Your Credentials With a Report +Redact any account, password, cookie, or token from the error message before sharing it. +::: diff --git a/en/docs/advanced-features/index.md b/en/docs/advanced-features/index.md index d862b7f..a3a6219 100644 --- a/en/docs/advanced-features/index.md +++ b/en/docs/advanced-features/index.md @@ -1,11 +1,18 @@ # Advanced Features -After learning the basic usage, you can follow the guides in this section to configure more advanced features. Use the sidebar to browse available topics. +Once the basics are working, these features make life easier: + +- [Emulator Management](./emulator) - register your emulator once and AUTO-MAS fills in the emulator settings for every script. Set this up first if you use an emulator. +- [Push Notifications](./notification) - sends a message to your email or phone when automation finishes. +- [Game Check-in](./game-sign) - takes care of the daily check-ins on each game's community site while it is at it. +- [MCP Service](./mcp) - lets an AI operate AUTO-MAS for you. ## Reference ### Common Date/Time Format Symbol Reference +You will need this when configuring [General Scheduling](/en/docs/script-guide/general): rewrite the date and time in your log using the symbols below. + | Symbol | Meaning | Example | |--------|---------|---------| | `%Y` | Four-digit year | 2025 | diff --git a/en/docs/advanced-features/mcp.md b/en/docs/advanced-features/mcp.md index b9e685c..48a0653 100644 --- a/en/docs/advanced-features/mcp.md +++ b/en/docs/advanced-features/mcp.md @@ -1,20 +1,14 @@ # MCP Service -Through the MCP service, AI clients can call tools and features provided by AUTO-MAS. +Once MCP is connected, you can just tell an AI "run the dailies on all my accounts today" and it drives AUTO-MAS to get it done. Almost anything you can click in the UI, the AI can do for you. -## What is MCP? +MCP (Model Context Protocol) is a common interface for AI to call external tools. You do not need to know how it works. Just put the address below into your AI client. -MCP (Model Context Protocol) is an open protocol designed to provide standardized interfaces for AI models, allowing them to connect to external data sources and tools. With MCP, AI can safely and efficiently call features without needing to understand the underlying implementation details. +## Configuration -## Configure the MCP Service +If your AI client supports MCP, enter this address: `http://localhost:36163/mcp` -For any MCP client that supports SSE, provide the AUTO-MAS MCP URL: - -```text -http://localhost:36163/mcp -``` - -Common MCP clients such as Claude Desktop, Cursor, and Windsurf also support the following configuration: +Clients like Claude Desktop, Cursor, and Windsurf take it as a config file instead: ```json { @@ -26,6 +20,10 @@ Common MCP clients such as Claude Desktop, Cursor, and Windsurf also support the } ``` -## Use the MCP Service +## Usage + +Once it is set up, **keep AUTO-MAS running**. The AI connects on its own, and from there you direct it in plain language. -After configuration, start the AUTO-MAS app. The AI client will discover and connect to this MCP service automatically, then call tools provided by AUTO-MAS to perform almost all tasks supported by AUTO-MAS. +::: warning The AI cannot connect if AUTO-MAS is not running +That address is a service AUTO-MAS provides itself. Close the app and the service goes with it, so the AI will report a connection failure. +::: diff --git a/en/docs/advanced-features/notification.md b/en/docs/advanced-features/notification.md index 0d90ab4..a4c3361 100644 --- a/en/docs/advanced-features/notification.md +++ b/en/docs/advanced-features/notification.md @@ -1,26 +1,24 @@ # Notifications -AUTO-MAS provides flexible **notification** features. You can configure which notifications to send and which channels to use. +Get told when a run finishes or an account fails. AUTO-MAS can send that news over email, ServerChan, or a WeCom group bot. -## Global Notifications +## Two Levels: Global and Per-User -Global notifications can be configured in **Settings > Notification Settings**. - -According to your push settings, notifications can be sent at any time. +**Global notifications** are configured in **Settings > Notification Settings** and cover every task. For most people this is the only one you need. ![notification-1](/docs/img/advanced-features/notification-1.png) -## User Notifications - -You can also configure user-level notifications in **User Configuration > Notification Settings**, allowing each user to have an independent notification plan. +**Per-user notifications** are configured in **User Configuration > Notification Settings** and let you name a separate recipient for one account. Typical case: you run accounts for a friend and he wants his own results. -> User notifications do not override global settings. They send one extra notification to the specified user after the global notification is sent. +::: tip A Per-User Notification Adds a Copy, It Does Not Change the Recipient +Once a per-user notification is set, the global notification still goes to you, and an extra copy goes to the address that user specifies. It does not replace the global setting. +::: ![notification-2](/docs/img/advanced-features/notification-2.png) -## SMTP Email Notification Channel +## Email Notifications -**SMTP** is a reliable email transfer protocol. AUTO-MAS uses **SMTP-SSL** to send email notifications. +To receive notifications by email you need three things: an **SMTP server address**, a **sending address**, and an **authorization code**. Here is how to get each one. ::: tip **AUTO-MAS private-domain email is available** @@ -43,7 +41,7 @@ You can also configure user-level notifications in **User Configuration > Notifi ### SMTP Server Address -Select the correct SMTP server address according to the email service provider of the sender mailbox. +Find the provider of your sending address and copy the matching row. | Email service provider | SMTP server address | | ---------------------- | ------------------- | @@ -53,18 +51,22 @@ Select the correct SMTP server address according to the email service provider o | **Outlook/Hotmail** | smtp-mail.outlook.com | | **Yahoo Mail** | smtp.mail.yahoo.com | -If your email service is not listed, visit its help center or search for its SMTP server address. +If your email service is not listed, search its help center for "SMTP server address". ### Get an Authorization Code -An **authorization code** is a special password used instead of your mailbox password for third-party client login. You need to fill in the authorization code of the sender mailbox. Common steps are: +**An authorization code is not your mailbox login password.** It is a separate code your provider issues for third-party software, and you have to go and generate it yourself. Getting this wrong is the most common reason email notifications fail. + +Providers name it differently: QQ Mail and 163 Mail call it an authorization code, while Gmail, Outlook, and Yahoo call it an **app password**. It is the same thing, and it goes in the same field. + +Where each provider hides it: 1. **QQ Mail** - Log in to your [QQ Mail Account and Security Center](https://wx.mail.qq.com/account). -- Go to **Account and Security > Security Settings > SMTP/IMAP Service**, enable the service, and obtain the authorization code. +- Go to **Account and Security > Security Settings > SMTP/IMAP Service**, enable the service, and get the authorization code. 2. **163 Mail** @@ -73,14 +75,14 @@ An **authorization code** is a special password used instead of your mailbox pas - Log in to [163 Mail](https://email.163.com). - Go to **Settings > POP3/SMTP/IMAP**, find **IMAP/SMTP Service**, and enable it. - In the popup, click **Continue enabling** and follow the instructions to send an SMS from your phone. -- The popup generates an **authorization password**, which is your authorization code. +- The popup generates an **authorization password**. That is the code you need. 3. **Gmail** - Log in to [Gmail](https://mail.google.com). - Go to **Settings > See all settings > Forwarding and POP/IMAP > IMAP access**, then select **Enable IMAP**. - Go to **User > Manage your Google Account > Security > 2-Step Verification** and enable **2-Step Verification**. -- Go to **2-Step Verification > App passwords** and create an **app password**. This password is your authorization code. +- Go to **2-Step Verification > App passwords** and create an **app password**. That is the code you need. 4. **Outlook/Hotmail** @@ -94,53 +96,45 @@ An **authorization code** is a special password used instead of your mailbox pas - Go to the account's **Security settings**. - Find **Generate app password** or a similar option to create an app password. -::: warning Note - -- For your security, do not share authorization codes with others, and rotate them regularly. -- Some mailbox authorization codes are shown only once. Save them immediately. Some authorization codes expire; replace them before expiration. -- AUTO-MAS encrypts local authorization code data with **Windows DPAPI**. This encryption uses the current user's login credentials as part of the encryption key, which means only the same user on the same computer can decrypt the data. If you need to migrate configuration files across devices, re-enter the authorization code. -- The SMTP email notification service **allows the sender mailbox and recipient mailbox to be the same**. If you do not have an extra mailbox, use the same email address for both sender and recipient. +::: tip One Mailbox Is Enough +The sending address and the recipient address can be the same. Mailing yourself works fine. ::: -## ServerChan Notification Channel +::: warning About the Authorization Code -**ServerChan** is a communication tool between a **phone** and a **server or smart device**. Its main purpose is: +- Do not share it with anyone, and rotate it now and then. +- Some providers show it **only once**, so save it as soon as you get it. Some expire, and notifications silently stop when they do, so replace it before then. +- It is stored encrypted on your machine, tied to your Windows account. **After changing computers or reinstalling Windows, you have to enter it again.** +::: -- Let servers, routers, and other devices push messages to a phone. -- In AUTO-MAS, it is used to **push messages to your phone after automation succeeds**. +## ServerChan (Push to Your Phone) -More information: +**ServerChan** is a relay service that forwards messages to your phone. Enter the key it gives you into AUTO-MAS and your run results get pushed to your phone. -::: warning Note -In 2024, ServerChan introduced a new App push channel. It differs from the original **ServerChan Turbo** (SCT) and was renamed **ServerChan³** (SC3). - -In the following configuration, **SCT** refers to **ServerChan Turbo**, and **SC3** refers to **ServerChan³**. -::: - -### SendKey +::: warning There Are Two Versions, Don't Mix Them Up +ServerChan released a new version in 2024, and the two are separate products: -**SendKey** is the authentication method used by the **ServerChan** platform. AUTO-MAS can push messages precisely to your device only when a **SendKey** is provided. +- **SCT** = ServerChan Turbo, the older version. It supports many channels, including WeChat, DingTalk, and Feishu. +- **SC3** = ServerChan³, the newer version. **It only pushes to its own app.** -SCT platform key: - +Some of the settings below apply to just one version, so check before you fill them in. +::: -SC3 platform key: - +### SendKey (Required) -::: warning Note -You only need to choose one of these two platforms. Pick according to your actual use case. -::: +The SendKey is how ServerChan identifies you, and messages have nowhere to go without it. Get yours from the page for your version. **Pick one platform, not both:** -#### ServerChanChannel Code +- SCT users: +- SC3 users: -**SC3 supports only App push**, so the **ServerChanChannel code** is available only for the SCT platform. +### Channel Code (SCT Only) -The following are **available message channel codes**. Fill in the corresponding numeric code. +To push messages to WeChat, DingTalk, and similar destinations, enter the matching numeric code. **SC3 users skip this** — SC3 only has app push. | Channel | Code | | ------- | ---- | @@ -155,47 +149,36 @@ The following are **available message channel codes**. Fill in the corresponding | PushDeer | 18 | | Fangtang service account | 9 | -::: tip **Multiple channel format** -Separate multiple channels with `|`, as shown below: - -- Incorrect: `1 | 0 | 9` +::: tip No Spaces When You List Several Channels - Correct: `1|0|9` +- Incorrect: `1 | 0 | 9` -If the format is incorrect, the system will use the **default push channel**. +A wrong format does not raise an error. It silently falls back to the **default channel**, so you may think your setting took effect when it did not. ::: -### Tag Content - -This is a **new SC3 platform feature** and applies only to **SC3**. +### Tag (SC3 Only) -::: tip **Tag format** -Separate multiple tags with `|`, as shown below: +Tags label your push messages so you can sort them in the app. **SCT users skip this.** -- Incorrect: `AUTO-MAS | Status` +::: tip No Spaces Here Either - Correct: `AUTO-MAS|Status` +- Incorrect: `AUTO-MAS | Status` -If left empty or formatted incorrectly, push messages will not include tag information. +Left empty or formatted wrong, messages simply arrive without tags. Pushing itself still works. ::: -## WeCom Group Bot Notification Channel +## WeCom Group Bot (Push to WeChat) -::: info Tip -This method only needs to be configured once in WeCom. After that, messages can be received directly in WeChat. +::: info Set It Up Once, Then Read Messages in WeChat +You do have to register WeCom, but that is a one-time step just to obtain a bot address. After that, messages arrive in your normal WeChat. ::: -1. Register an enterprise account - - Open the on a computer and follow the instructions to register an enterprise account. - - After registration, log in to the WeCom client using the WeChat account or phone number bound during registration. +1. **Register an enterprise account**: open the on a computer, follow the instructions, then log in to the WeCom client with the WeChat account you bound. -2. Add a group bot - - **Desktop**: enter an internal group chat, click the **...** menu in the upper-right corner, and select **Add group bot**. - - **Mobile**: enter an internal group chat, tap the **...** menu in the upper-right corner, and select **Add group bot**. - - The bot name and avatar can be filled in freely. +2. **Create a group and add a bot**: open the group chat, click the **...** menu in the upper-right corner, and select **Add group bot**. Name and avatar are up to you. This works on desktop and mobile alike. -3. Get the group bot Webhook URL - - The bot creator can view the corresponding Webhook URL in the bot information. - - **Mobile**: enter the group chat, tap the **...** menu in the upper-right corner, select **Group bot**, then tap the corresponding bot to see the Webhook URL. - - **Desktop**: in the group chat, right-click the corresponding bot and select **View profile** to get the Webhook URL. +3. **Get the Webhook URL**: + - Desktop: right-click the bot in the group chat and select **View profile**. + - Mobile: group chat, **...** menu in the upper-right corner, **Group bot**, then tap the bot. -4. Configure push - - Fill the obtained Webhook URL into AUTO-MAS **Push WeCom bot notification** configuration to enable message push. +4. **Enter it in AUTO-MAS**: paste the Webhook URL into **Push WeCom bot notification**. Done. diff --git a/en/docs/script-guide/general.md b/en/docs/script-guide/general.md index b90d741..29fcf07 100644 --- a/en/docs/script-guide/general.md +++ b/en/docs/script-guide/general.md @@ -6,145 +6,164 @@ date: 2025-07-16 # General Scheduling -::: warning Before You Start -General scheduling has a learning curve. To configure a general script on your own, you need to understand the behavior of the script itself. +::: tip Start here: most people never configure this by hand +AUTO-MAS ships with a set of ready-made templates. Go to **New general script > Create from template**, pick a template, fill in one script path, and you are done. -If you do not know much about the script you want to schedule, you can import a configuration shared by another user. However, general scheduling cannot guarantee the same stability as a dedicated script integration. Do not blame configuration contributors too harshly. - -If you decide to use this feature, read this document carefully before asking questions. +March7thAssistant, SRC, zzzOD, M9A and other common scripts all have mature templates. Check the list before you build anything yourself. ::: -::: tip Tip +::: warning Configuring from scratch means knowing your script +If your script is not in the template list, you have to write the monitoring rules yourself. That means knowing what its log looks like and how it starts up. If you are not familiar with it, import a config someone else has shared instead. -AUTO-MAS already includes many ready-to-use templates. You can configure them through **New General Script > Create from Template** and only need to fill in the script software path. +General scheduling is also usually less stable than a script AUTO-MAS supports directly. That is how the mechanism works, so go easy on the people who share configs. +::: -Currently, mature templates are available for common scripts such as March7thAssistant, SRC, zzzOD, and M9A. +## How It Works -If you run into problems, join the user group and discuss them with developers and template contributors. +Understand these two things and you can diagnose most problems yourself. -::: +### Config Handling: Borrow and Return -## Scheduling Model +AUTO-MAS does not parse the script's config format. It keeps the whole config instead. Before a task starts, it copies your saved config into the script's directory as-is. After the task ends, it puts the script's original config back. -Before using this feature, understand the basic mechanism of **general scheduling**. This makes later troubleshooting much easier. +So every user runs with its own config, and nothing you set by hand inside the script gets polluted. -### Configuration Management +### Success and Failure: Watching the Log -AUTO-MAS manages configuration by directly saving script configuration files or folders. Before a task starts, the corresponding configuration files are imported into the target script location as-is. After the task ends, the original configuration files inside the script are restored. +AUTO-MAS cannot read the script's UI. It watches three things only: **what text appears in the log**, **when the log was last written to**, and **whether the script process has exited**. -### Script Monitoring +Which rules apply depends on whether you filled in **task success logs**: -AUTO-MAS determines script status through **log text**, **log timestamps**, and **whether the script process has ended**. The logic is: +| You filled in a success keyword | You left the success keyword blank | +| --- | --- | +| The success keyword appears in the log -> **success** | The script exits on its own and no error keyword ever appeared -> **success** | +| The script exits but the success keyword never appeared -> **failure** | An error keyword appeared before the script exited -> **failure** | -- Success: If **task success logs** are configured and any success log text appears in the **log text**, the task is considered successful. If **task success logs** are empty, and no **task error log** appears in the **log text** when the **script process ends**, the task is considered successful. -- Failure: If the last **log timestamp** exceeds the **auto-proxy timeout limit**, the task is considered failed due to timeout. If a **task error log** appears before a **task success log**, the task is considered failed. If **task success logs** are configured, but no success log appears in the **log text** when the **script process ends**, the task is considered failed. +Two more rules always apply: + +- An error keyword appears before the success keyword -> **failure** +- The log goes untouched for longer than the **auto-proxy timeout limit** -> treated as a hang, **timeout failure** Using MAA as an example: ![AUTO workflow](/docs/img/AUTO工作逻辑.png) ## Script Settings -To let AUTO-MAS schedule a general script correctly, users need to configure script properties accurately. These settings directly affect automation stability. +These settings decide how AUTO-MAS handles your script. Getting them right is what makes automation stable. ### Script Root Directory -- **Type**: folder +Pick the **folder** the script lives in. Fill this in first; the other paths depend on it. -- **Description**: This setting helps users relocate the script program. When the script program location changes, you only need to reset the root directory, and other paths will update automatically. +If you move the script later, change this one setting and the paths below follow automatically. No need to reselect them one by one. ### Script Path -- **Type**: executable file - -- **Description**: The script's main program. Both script configuration and task execution require this file. +Pick the script's **main executable**, the file you would normally double-click to start it. -- **Common issues**: - - - **The program says the selected path is not under the script root directory**: this means exactly what it says. Check the script root directory. - - **The script cannot start during configuration or auto-proxy**: check whether the path and launch arguments are correct. Specific errors can be found in `debug/AUTO-MAS.log`. +- **"The selected path is not under the script root directory"**: exactly what it says. Go back and check the script root directory. +- **The script will not start**: either the path or the launch arguments are wrong. Check `debug/AUTO-MAS.log` for the actual error. ### Script Launch Arguments -- **Type**: text segments separated by `|`, `%`, and spaces +**Most scripts do not need this. Leave it empty and try that first.** -- **Description**: This setting adds extra commands when starting a script task. Some scripts do not provide a `run immediately after startup` option in the UI, but support the same behavior through command-line arguments. For those scripts, configure this item so the script runs its task after startup. +Some scripts have no "start running as soon as it opens" option in their UI and can only do it through command-line arguments. Those are the ones that need this field. -- **How to configure**: Read the script software's official website or documentation, find sections such as **CLI run**, **command-line startup**, or similar, then fill in the required arguments. Make sure the script can run its task automatically with the entered launch arguments. If the arguments for running a task are different from those for configuring the script, enter both and separate them with `|`. If the executable used for running a task is different from the executable used for configuration, enter the executable path relative to the `script path` before the corresponding arguments, separated by `%`. +**How to find them**: check the script's website or docs for a **command line** or **CLI** section, and copy the arguments that make it run a task on startup. -- **Format**: `{auto-proxy executable path relative to script path}%{auto-proxy task arguments}|{configuration executable path relative to script path}%{configuration task arguments}` +You only need the separators if your script is one of these two special cases: -### Track Script Child Processes +- **Configuring and running a task take different arguments** -> separate the two sets with `|`. Task arguments first, config arguments second. +- **Configuring and running a task use different executables** -> put that executable's path relative to the `script path` in front of the arguments, separated by `%`. -- **Type**: toggle +The full format looks like this (leave out the parts you do not need): -- **Description**: Determines whether child processes are considered when judging **whether the script process has ended**. Some scripts must be opened through a **launcher**. After the main program starts, the launcher exits automatically, so the launcher process alone cannot represent whether the whole script is still running. Enable this option for such scripts. +```text +{task executable}%{task arguments}|{config executable}%{config arguments} +``` + +### Track Script Child Processes -- **Common issues**: +**Leave this on the default. Only change it if something goes wrong.** - - **After manually closing the script, the app does not detect that the script has closed**: try disabling this option. - - **The script is still running, but the app incorrectly reports that it has exited**: try enabling this option. +Some scripts work like this: a launcher starts the main program, then the launcher exits. Watching only the launcher process would make AUTO-MAS think the script already finished. Turn this on for those scripts so child processes are watched too. -### Script Configuration File Path +- **The script closed but AUTO-MAS still thinks it is running** -> turn this off. +- **The script is still running but AUTO-MAS says it exited** -> turn this on. -- **Type**: any file or folder +### Script Config File Path -- **Description**: The file or folder where the script stores configuration. +Pick the file or folder where the script stores its config. -- **How to configure**: Open the script directory. Usually there is a file or folder named `config`; this is very likely the **script configuration file**. +**How to find it**: open the script directory and look for a file or folder with `config` in the name. That is usually the one. ### Script Log File Path -- **Type**: any file +Pick the file the script writes its log to. -- **Description**: The file where the script stores logs. +**How to find it**: open the script directory and look for a folder like `debug` or `log`. -- **How to configure**: Open the script directory and check whether a folder named `debug`, `log`, or similar exists: - - If it exists, enter that folder and look for files whose names do not include date information, such as `log.txt` or `gui.log`: - - If such a file exists, select it. - - If not, select any file that stores log information, usually with a `.log` or `.txt` extension, then configure **script log file name format**. - - If no such folder exists, check whether the script root contains `.txt` or `.log` files. If so, open them and confirm whether they contain script logs, then select the correct file. +- **That folder exists**: go in and pick a `.log` or `.txt` file. + - The filename has **no date** in it (`log.txt`, `gui.log`) -> select it and you are done. + - The filename **has a date** in it (`2025-06-29.log`) -> select it too, then also fill in **script log file name format** below. +- **No such folder**: look for `.txt` or `.log` files in the script root, open them to confirm they hold log output, and select the right one. ### Script Log File Name Format -- **Type**: text indicating a date/time format +**If the log filename has no date in it, leave this empty.** -- **Description**: Indicates the naming format of real-time log files. Some scripts do not write logs to one fixed file, but write them to different files by date. For these scripts, configure the log file name format so AUTO-MAS can locate the actual log file. +Some scripts create a new log file every day with the date in the filename. AUTO-MAS needs to know the naming pattern to find today's file. -- **How to configure**: Copy any script log file name into this field, then replace date and time elements with the corresponding symbols according to the [common date/time format symbol reference](/en/docs/advanced-features/#common-date-time-format-symbol-reference). Example: `2019-05-01` -> `%Y-%m-%d`. +**How to fill it in**: copy one log filename in here, then replace the date and time parts with symbols. For example, `2019-05-01` becomes `%Y-%m-%d`. See the [date and time format symbol table](/en/docs/advanced-features/#common-date-time-format-symbol-reference) for what each symbol means. ### Script Log Timestamp Start/End Position -- **Type**: number +This tells AUTO-MAS which character each log line's timestamp starts and ends at. It uses that to tell whether the script has stopped moving. -- **Description**: Locates the start and end positions of the timestamp in each log line so the app can parse it. +**How to count**: take any log line with a timestamp and count characters from `1`. For example: -- **How to configure**: Find any log line with a timestamp. Count from `1` to the first character of the timestamp; that number is the start value. Continue counting to the last character of the timestamp; that number is the end value. For example, in `[2025-06-29 20:00:35.909][INF] <1><> Start task`, the start value is `2` and the end value is `24`. +```text +[2025-06-29 20:00:35.909][INF] <1><> 开始任务 +``` -### Script Log Time Format +`[` is position 1, so the timestamp starts at position 2 and ends at position 24. Enter `2` for start and `24` for end. -- **Type**: text indicating a date/time format +### Script Log Time Format -- **Description**: Indicates the format of log timestamps so the app can parse them. +Write that timestamp out in symbols so AUTO-MAS can read the time from it. -- **How to configure**: Copy any script log timestamp into this field, then replace date and time elements with the corresponding symbols according to the [common date/time format symbol reference](/en/docs/advanced-features/#common-date-time-format-symbol-reference). Example: `2019-05-01 16:00:00.000` -> `%Y-%m-%d %H:%M:%S.%f`. +For example, `2019-05-01 16:00:00.000` becomes `%Y-%m-%d %H:%M:%S.%f`. See the [date and time format symbol table](/en/docs/advanced-features/#common-date-time-format-symbol-reference) for what each symbol means. ### Script Success/Failure Logs -- **Type**: text segments separated by `|` +Enter keywords. When AUTO-MAS spots one in the log, it calls the task a success or a failure. You can enter several, separated by `|`. + +**How to find them**: run the script once by hand, open its log file, and find the line it prints when it finishes (something like "All tasks complete"). Copy a short, unchanging fragment of that line into **success logs**. Do the same with the line it prints on an error and put that in **failure logs**. + +Pick something that only shows up on success. Do not pick a generic message the script prints on every run, or you will get false results. -- **Description**: Reference text for judging script runtime status. Multiple entries are supported and separated by `|`. +## Sharing and Importing Configs -- **How to configure**: Customize this based on your experience and the script log content. +Once you have a script configured, you can export it as a JSON file and share it. You can import someone else's JSON the same way. To get it in front of more people, submit it to the **AUTO-MAS config sharing centre**; once it passes review, every user can import your config with one click. -## Configuration Management +::: warning Check your paths yourself before sharing +Exporting and uploading both scrub the config, but **only some of the paths**. You have to check the rest. -Because general scheduling has a learning curve, general scripts support quick configuration import and export. You can export configuration to a `JSON file` and share it with other users, import a `JSON file` shared by another user, or upload your configuration to the `AUTO-MAS Configuration Sharing Center`. After review, all users can import it with one click. +Handled automatically: -::: warning Note -- To prevent privacy leaks, the script root directory will be replaced with `C:/ScriptRoot`. Users must reselect it after importing. -- `Game/emulator paths` are not replaced automatically. Check whether these paths may expose personal information. +- The **script root directory** is replaced with the placeholder `C:/脚本根目录`. (That string is hardcoded in Chinese and is not translated.) So **the first thing to do after importing someone else's config is reselect your own script root directory**. +- The **script path, config file path, log file path, and tracked process path** are rewritten relative to the placeholder if they sit under the script root directory. If they sit under `AppData` instead — SRA's config directory, for example — they are rewritten as `%APPDATA%/...`, so your Windows username does not leak. + +You have to check these yourself: + +- The **game and emulator path is not scrubbed**. It is exported as-is. +- Those four script paths are also exported as-is if they are under neither the script root directory nor `AppData`. + +So open the exported JSON and skim it before sharing. If you see a path with your real name in it, such as `C:/Users/YourName/...`, edit it out first. ::: ## Subordinate Users -**Subordinate users** work the same way as **subordinate users** in MAA scripts. Each sub-configuration runs similarly to the detailed mode of MAA user configuration. Each sub-configuration must be configured separately, using the same method as MAA configuration. +One general script can hold several users. Each user stores its own copy of the script config, and AUTO-MAS swaps them in one at a time as it runs tasks. It works the same way as users under a MAA script, and each user has to be configured separately. + diff --git a/en/docs/script-guide/hsr.md b/en/docs/script-guide/hsr.md index 54d0c2a..1a99cb7 100644 --- a/en/docs/script-guide/hsr.md +++ b/en/docs/script-guide/hsr.md @@ -1,33 +1,31 @@ --- -title: HSR Honkai Star Rail User Guide +title: HSR Honkai Star Rail Configuration Guide description: "Schedule Honkai: Star Rail external scripts in AUTO-MAS with M7A and SRA" date: 2026-06-17 --- -# HSR Honkai Star Rail User Guide +# HSR Honkai Star Rail Configuration Guide -::: tip Scope -The HSR specialization is used to schedule Honkai: Star Rail external scripts in AUTO-MAS. It was introduced with [AUTO-MAS PR #249](https://github.com/AUTO-MAS-Project/AUTO-MAS/pull/249) and corresponds to the built-in AUTO-MAS script type **HSR**. -::: - -## What Is the HSR Specialization? +## What the HSR Script Type Is For -The HSR specialization is a built-in AUTO-MAS script adapter that connects two mainstream third-party PC tools for Honkai: Star Rail: +Honkai: Star Rail has two widely used third-party scripts, and each is better at different things: -- **March7th Assistant (M7A)**: the M7A route, good at stamina farming scripts and weekly tasks. -- **StarRailAssistant (SRA)**: the SRA route, good at daily rewards, Divergent Universe, and related tasks. +- **March7th Assistant (M7A)**: better at stamina stages and weekly tasks. +- **StarRailAssistant (SRA)**: better at collecting daily rewards and at Divergent Universe. -With the HSR specialization, AUTO-MAS can mix both engines under one script and automatically manage game startup, script invocation, failure retries, and weekly/monthly progress. +That is the point of the HSR script type: **you do not have to choose one**. Run both under a single script and decide task by task which one handles it. AUTO-MAS starts the game, calls the scripts in order, retries failures, and remembers whether this week's weekly tasks and this month's monthly tasks are already done. -**Supported gameplay coverage** depends on the script version you use: +**What it can run** (exact coverage depends on the script versions you install): - Stamina stages: Calyx (Golden), Calyx (Crimson), Cavern of Corrosion, Planar Ornament Extraction - Echo of War, reset weekly -- Daily tasks and rewards, such as redemption codes, mail, assignments, Nameless Honor, and Daily Training -- Weekly tasks: Divergent Universe (PVE mode), Currency Wars (PVP mode) -- Monthly tasks: the three endgame modes, Memory of Chaos / Pure Fiction / Apocalyptic Shadow +- Daily tasks and rewards: redemption codes, mail, assignments, Nameless Honor, Daily Training, and more +- Weekly: Divergent Universe, Currency Wars +- Monthly: the three endgame modes (Memory of Chaos / Pure Fiction / Apocalyptic Shadow) -> **About the three endgame modes**: AUTO-MAS has reserved configuration entries and snapshot import capability for these modes, but during PR #249 the user-page switch is temporarily disabled and marked as "Future feature". Availability and stability depend on your current AUTO-MAS version. Do **not** treat this as a stable feature yet. +::: warning The three endgame modes are not usable yet +The configuration entries are in place, but the current version disables the switch in the UI and the feature has not been tested enough. Trust your actual UI, and **do not count on this feature for now**. +::: **For more information, see:** @@ -38,251 +36,216 @@ With the HSR specialization, AUTO-MAS can mix both engines under one script and { name: 'SRA GitHub', link: 'https://github.com/Shasnow/StarRailAssistant', image: { light: '/icons/github.svg', dark: '/icons/github-dark.svg', }, }, ]"/> -## Prerequisites +## Before You Start -Before creating your first HSR script in AUTO-MAS, complete these steps: +Get these out of the way first. It removes about half the problems people run into later. -1. **Install AUTO-MAS**: use a version that includes the HSR specialization, meaning a version after PR #249 was merged. -2. **Install March7th Assistant (M7A)**: after extraction, **open it manually at least once** and wait for initialization to complete. The first launch creates files such as `config.yaml`. Confirm that the directory contains `March7th Assistant.exe`. -3. **Install StarRailAssistant (SRA)**: after extraction, **open it manually at least once** so SRA can generate `settings.json`, `configs`, and related directories. Confirm that the directory contains `SRA-cli.exe`. -4. **Install the Honkai: Star Rail PC client**: the CN official client is supported. Confirm that the directory contains `StarRail.exe`. -5. **Add antivirus and Defender trust entries**: add AUTO-MAS, M7A, SRA, and the Honkai: Star Rail game directory to Windows Defender or third-party antivirus trust lists to avoid external scripts being blocked. -6. **Avoid Chinese paths**: place all directories under plain English paths, such as `D:\AUTO-MAS`, `D:\M7A`, `D:\SRA`, and `D:\StarRail`. Chinese paths and paths with spaces have historically caused image recognition and path parsing issues. +1. **Install the scripts you want to use.** At least one of M7A and SRA. Install both if you want to mix them. +2. **Open each script manually once and let it finish initializing.** Do not skip this. A script only writes its config files on first launch, and AUTO-MAS reads those files to know which stages you can pick. Skip it and the stage dropdowns will be empty. +3. **Install the Honkai: Star Rail PC client**, the CN official client. +4. **Add everything to your antivirus allowlist**: AUTO-MAS, M7A, SRA, and the game directory. Otherwise the scripts get blocked and tasks fail for no visible reason. +5. **Keep paths free of non-English characters and spaces**, for example `D:\M7A` and `D:\SRA`. Such paths have a long history of breaking image recognition and path parsing. -::: warning Reminder -When saving paths, AUTO-MAS automatically checks whether the selected directory contains the expected `exe`: +::: warning Pick the folder, not the exe +When you save, AUTO-MAS checks that the folder you picked contains the matching exe. Pick the wrong thing and a popup stops you right there: -- March7th path: must contain `March7th Assistant.exe` -- SRA path: must contain `SRA-cli.exe` -- Game path: must contain `StarRail.exe` - -If you select the wrong directory, the frontend blocks it with a popup and asks you to reselect. +| This field | Needs this file in the folder | +| --- | --- | +| March7th path | `March7th Assistant.exe` | +| SRA path | `SRA-cli.exe` | +| Game path | `StarRail.exe` | ::: ## Create an HSR Script -### 1. Create a Script +### 1. Create the script -1. Go to **Script Management**. -2. Click **New Script**. -3. In the script type list, select **HSR Script** (type ID: HSR). -4. Click OK. AUTO-MAS creates an HSR script instance and opens the script configuration page. +Go to **Script Management** → **New Script** → select **HSR Script** → confirm. AUTO-MAS opens the script configuration page. -### 2. Configure Basic Script Information +### 2. Fill in paths and basic information -Fill in the **HSR Script Configuration** page: +| Configuration | What to enter | +|---|---| +| **Script name** | Any name you will recognize, such as "Main HSR account" | +| **March7th path** | The **folder** M7A is in | +| **SRA path** | The **folder** SRA is in | +| **Game path** | The **folder** Honkai: Star Rail is in | +| **Maximum game startup wait time** | How many seconds to wait after starting the game before acting. Default 60. Raise it on slow machines | +| **Game startup arguments** | Leave empty | -| Configuration | Description | Notes | -|---|---|---| -| **Script name** | Give this script instance an easy-to-recognize name | For example, "Main HSR account" or "Official daily" | -| **March7th path** | M7A installation directory containing `March7th Assistant.exe` | Validates the exe; can be cleared with one click | -| **SRA path** | SRA installation directory containing `SRA-cli.exe` | Validates the exe; can be cleared with one click | -| **Game path** | Honkai: Star Rail installation directory containing `StarRail.exe` | Validates the exe | -| **Maximum game startup wait time** | Seconds AUTO-MAS waits after starting the game before the client is considered operable | Default is 60 seconds; increase it for slower machines | -| **Game startup arguments** | Extra command-line arguments passed when starting `StarRail.exe` | Usually left empty | - -::: tip Notes -- At least one of the M7A and SRA paths must be configured. Leaving the other side empty is allowed; that side will not appear in **Module Script Assignment**. -- After any path is changed, Module Script Assignment (TaskMapping) is automatically reshuffled according to the currently configured paths. +::: tip One script is enough +Fill in either M7A or SRA and leave the other empty. The empty one will not appear in the task assignment below. + +After you change a path, task assignment is reshuffled to match the paths you currently have. Go back and check it. ::: -### 3. Configure Execution Limits +### 3. Set retries and timeouts + +These decide how long a task can run before it counts as stuck, and how many times a failure is retried. The defaults suit most people. Raise them on slow machines. | Configuration | Description | Default | |---|---|---| -| **Maximum failed task retries** | Upper limit for automatic retries after a task fails | 3 | -| **Daily task timeout limit (minutes)** | Maximum duration for one daily, stamina, or reward task | 20 | -| **Weekly task timeout limit (minutes)** | Maximum duration for one weekly task such as Divergent Universe or Currency Wars | 60 | -| **Monthly task timeout limit (minutes)** | Maximum duration for one monthly task such as the three endgame modes | 60 | -| **Enable low-performance compatibility mode** | Only affects March7th Divergent Universe and maps to `weekly_divergent_stable_mode` | Disabled | +| **Maximum failed task retries** | How many extra attempts a failed task gets | 3 | +| **Daily task timeout limit (minutes)** | Cap for daily, stamina, and reward tasks | 20 | +| **Weekly task timeout limit (minutes)** | Cap for Divergent Universe and Currency Wars | 60 | +| **Monthly task timeout limit (minutes)** | Cap for the three endgame modes | 60 | +| **Enable low-performance compatibility mode** | Only affects M7A running Divergent Universe. Turn it on if M7A runs it unreliably | Disabled | -### 4. Module Script Assignment (TaskMapping) +### 4. Decide which script runs which task -The HSR specialization can assign four modules to M7A or SRA separately: +This is the heart of the HSR script type: four groups of tasks, each assigned to one script. -| Module | Meaning | Default engine | +| Module | What it covers | Default | |---|---|---| -| **Stamina** | Trailblaze Power farming, Echo of War, and related tasks | SRA | +| **Stamina** | Trailblaze Power stage farming, Echo of War | SRA | | **Daily tasks and rewards** | Redemption codes, mail, assignments, Nameless Honor, Daily Training, and more | SRA | -| **Divergent Universe** | Divergent Universe PVE mode | SRA | -| **Currency Wars** | Currency Wars PVP mode | SRA | +| **Divergent Universe** | Divergent Universe | SRA | +| **Currency Wars** | Currency Wars | SRA | -> TaskMapping options change dynamically based on configured M7A / SRA paths. You can choose between both only when both paths are configured. If only one path is configured, only that engine is available. +If you filled in only one script path, that is the only option here. Fill in both to choose freely. -When a different engine is selected, the **Weekly Task Execution Strategy** area displays the concrete parameters for that engine. **The user page no longer requires you to fill in these parameters manually**: +Once you choose, the page shows the exact strategy that script uses for the task. **These strategies are fixed. You do not fill them in, and you do not set them again on the user page**: - **Divergent Universe** - - SRA: Divergent Universe adventure notes / farm first stage mode / 20 runs / enable points reward - - March7th: enable points reward / cyclical extrapolation / low-performance compatibility follows the script-page switch; team, blessings, and extrapolation strategy are decided by the M7A client + - SRA: Paradise Chronicle / farm the first stage / 20 runs / claim points rewards + - M7A: claim points rewards / cyclical extrapolation / low-performance compatibility follows the switch above. Team, blessings, and extrapolation strategy are up to M7A - **Currency Wars** - - SRA: standard game / lowest difficulty / first strategy saved in SRA / 2 runs - - March7th: enable points reward / standard game / lowest rank / Aglaea strategy / accept restart for specific entries + - SRA: standard game / lowest difficulty / the first strategy saved in SRA / 2 runs + - M7A: claim points rewards / standard game / lowest rank / Aglaea strategy / restarts on certain entries -::: warning SRA Currency Wars Note -After SRA finishes Currency Wars, it **does not automatically claim points rewards**. Claim them manually in game. Other engines handle rewards according to their own client rules. +::: warning Running Currency Wars on SRA means claiming rewards yourself +SRA **does not claim points rewards** after it finishes Currency Wars. You have to collect them in game. Assign Currency Wars to M7A instead and the problem goes away. ::: ## Create an HSR User -Add a user under the HSR script: - -1. In the **Script Management** table, click **Add User**, or open the created HSR script and click **Add User** there. -2. Fill in **Basic Information**: +Click **Add User** in the **Script Management** table, then fill in the basics: -| Field | Description | +| Field | What to enter | |---|---| -| **Username** | Display name for the user. It is also written to M7A / SRA as the "Trailblazer name" for Currency Wars | -| **Enabled** | Whether the user participates in automation. Disabled users are skipped | -| **Account** | Login account, such as a phone number. Only used when automatic login/account switching is required | -| **Password** | Login password. Only used when automatic login/account switching is required | -| **Server** | Currently only the official CN server (CN-Official) is supported | -| **Remaining days** | Remaining valid automation days. `-1` means unlimited, `0` means expires today, and a positive value is the remaining day count | -| **Notes** | Free-form notes | - -::: warning Account and Password Security -- Accounts and passwords are stored locally and encrypted automatically by AUTO-MAS when saved. -- **If the SRA path is not configured, or TaskMapping does not assign a module to SRA, the account and password are not used for account switching**. They are only reserved fields. -- **Do not publicly share your `data/` directory or script configuration JSON files**, because they contain encrypted credentials. -::: +| **Username** | Display name. It is also passed to the script as the "Trailblazer name" for Currency Wars | +| **Enabled** | Disabled users are skipped | +| **Account** | Login account such as a phone number. Only needed for automatic account switching | +| **Password** | Login password, same as above | +| **Server** | Only the official CN server for now | +| **Remaining days** | How many days of automation are left. `-1` means unlimited. Each run subtracts one day, and at 0 the user is skipped | +| **Notes** | Anything you like | + +::: warning About the account and password +They are stored locally and encrypted automatically. Nothing is uploaded. -### Task Switches +**If you did not fill in an SRA path, or no task is assigned to SRA, the account and password are never used at all.** Leave them empty. -Configure which modules this user should run: +Also, do not hand your `data/` directory or script configuration JSON to anyone else. They contain your encrypted credentials. +::: + +### Which tasks this user runs | Switch | Description | Default | |---|---|---| -| **Stamina** | Whether to run stamina stages and Echo of War | Disabled | -| **Daily tasks and rewards** | Whether to run redemption codes, mail, assignments, Nameless Honor, Daily Training, and more | Disabled | -| **Three endgame modes** (monthly, all three run together) | The current UI marks this as **disabled**. Whether it is available depends on your actual version | Disabled | -| **Divergent / Currency** | Three-way choice: Off / Divergent Universe / Currency Wars | Disabled | +| **Stamina** | Stamina stages plus Echo of War | Disabled | +| **Daily tasks and rewards** | Redemption codes, mail, assignments, Nameless Honor, Daily Training, and more | Disabled | +| **Three endgame modes** | Once a month, all three together. Disabled in the current UI | Disabled | +| **Divergent / Currency** | Pick one of three: neither / Divergent Universe / Currency Wars | Disabled | -The UI shows the execution strategy for the engine selected in TaskMapping, consistent with the script page. +Turn a switch on and the page shows which script will run it and with which strategy, matching what the script page showed. There is nothing to set twice. ## Configure Stamina Stages -In the **Stamina Configuration** area, you can see four independent dropdowns: +The **Stamina Configuration** area has four dropdowns, one per stage type. Leave any of them empty if you do not want to farm it: -| Channel | Corresponding stage type | +| Dropdown | What it farms | |---|---| | **Calyx (Golden)** | Character EXP / Light Cone EXP / Credits | -| **Calyx (Crimson)** | Trace materials. Golden and Crimson selections do not overwrite each other and can be saved at the same time | -| **Cavern of Corrosion** | Relic stages | -| **Planar Ornament Extraction** | Planar Ornament stages | - -Each channel is independently selectable. Leave stages empty if you do not want to farm them. - -The following fields are also available: - -- **Stage to farm**: choose the channel to farm this time, such as Golden, Crimson, Relic, or Ornament. This writes to `Stage.Channel`. -- **Current active stage**: the UI displays the stage name or stage ID corresponding to `Stage.ScriptStage`. -- **Echo of War**: choose one Echo of War stage read from the external script. Leave empty if you do not want to run it. -- **Echo of War start day**: Monday through Sunday. Once the start day is reached and this week is not complete, AUTO-MAS asks M7A / SRA to try completing it. After logs confirm completion, it will not run again that week. - -### Where Do Stage Options Come From? +| **Calyx (Crimson)** | Trace materials | +| **Cavern of Corrosion** | Relics | +| **Planar Ornament Extraction** | Planar Ornaments | -Stamina stage options **only come from the stage configuration exposed by the external script**, read dynamically according to the engine selected for the **Stamina** module in TaskMapping: +Golden and Crimson do not affect each other. You can keep a selection in both. -- M7A: read from `instance_names.json` -- SRA: read from `trailblaze_power.toml` +Below that: -If a dropdown is empty, common causes are: +- **Stage to farm**: from the four types above, pick the one to actually farm this time. +- **Current active stage**: shows the stage you selected, just so you can confirm it. +- **Echo of War**: pick one of the stages read from the script, or leave it empty to skip. +- **Echo of War start day**: set a day of the week. From that day on, AUTO-MAS runs it if it is not done yet this week, and stops once it is done. -1. The external script, M7A or SRA, has not been initialized. Open it manually once first. -2. The external script path is wrong, so AUTO-MAS cannot find configuration files. -3. You changed the Stamina execution engine in TaskMapping, for example from SRA to M7A, and need to **reselect stages**. +### Dropdowns are empty? -> When the Stamina execution engine is changed, the Stamina Configuration area displays a yellow notice: "The stamina execution script has changed. Please reselect stages." +Those stage options are not invented by AUTO-MAS. They are **read out of your M7A or SRA**, specifically whichever script you assigned Stamina to. So an empty list almost always comes down to one of three things: -## Weekly and Monthly Notes +1. **The script was never initialized** → open M7A or SRA manually once and let it finish. This is by far the most common cause. +2. **The script path is wrong** → AUTO-MAS cannot find the config files. Go back and check the path. +3. **You just switched which script runs Stamina** (for example SRA to M7A) → the two have different stage lists, so you need to **pick your stages again**. The page shows a yellow notice when this happens. -HSR weekly and monthly progress is recorded automatically by AUTO-MAS. **The user page does not require manual choices such as "Divergent Universe 1 / Divergent Universe 2"**: +## AUTO-MAS Handles Weekly and Monthly Tasks for You -- **Divergent Universe and Currency Wars**: weekly tasks. Completion is recorded by ISO week, such as `2025-W23`. If the weekly task is already complete this week, the next run skips it. -- **Three endgame modes**: monthly tasks. They run once per month and consist of three snapshots, Memory of Chaos / Pure Fiction / Apocalyptic Shadow. Completion is recorded by calendar month, such as `2025-06`. -- **Echo of War**: reset by ISO week. Users can specify an **Echo of War start day**. It is only attempted after that day is reached, and it will not repeat after completion this week. +AUTO-MAS keeps this bookkeeping itself. **The user page never asks you to pick something like "Divergent Universe 1 / Divergent Universe 2"**: -### Progress and Reset +- **Divergent Universe, Currency Wars, Echo of War**: recorded weekly. Once done this week, later runs skip it, and it unlocks again on Monday. +- **Three endgame modes**: recorded monthly, run once a month. -The **Progress and Reset** area at the bottom of the user page provides three manual controls: +### Changing progress by hand -- **Echo of War**: shows "completed this week / not completed" and the latest completion date. Provides **Mark Complete** and **Reset** buttons. -- **Weekly**: same behavior, judged by ISO week. -- **Three endgame modes**: judged by calendar month. Provides **Mark Complete This Month** and **Reset** buttons. +The **Progress and Reset** area at the bottom of the user page shows whether Echo of War, the weekly tasks, and the three endgame modes are done this week or this month. Each one has **Mark Complete** and **Reset**. -> These buttons only modify the local `Data` field and **do not actually drive external scripts**. They are used to quickly synchronize state when an external script has already completed the task, or when you want to force a rerun. +Two situations call for it: you already did it yourself in game and want AUTO-MAS to skip it, or you want to force a re-run, in which case you hit Reset. -### About the Three Endgame Modes - -AUTO-MAS has prepared a complete pipeline for the three endgame modes, including: - -- User page: switch ForgottenHall and import three snapshots in the UI -- Script page: import three snapshots from M7A `config.yaml` in one click: Memory of Chaos / Pure Fiction / Apocalyptic Shadow - -However, **during PR #249 the user-page switch for these modes is disabled** to avoid misuse before sufficient testing. It will be opened gradually in later versions. Use the actual AUTO-MAS UI as the source of truth. - -## Runtime and Logs +::: tip These buttons only change records +They change AUTO-MAS's own bookkeeping and **do not drive the scripts to run anything**. +::: -After configuring scripts and users, add the script to the task scheduler queue for execution. Daily-use notes: +## Running and Logs -- **AUTO-MAS restarts the game when switching between M7A and SRA**. This avoids state pollution between external scripts and is expected behavior. -- **AUTO-MAS does not destroy M7A / SRA's own configuration**. Before running, it backs up `config.yaml`, `settings.json`, `cache.json`, and `configs`, then restores them automatically after the run. -- **Automatic retry after failure**: when one task inside a module fails, AUTO-MAS retries according to **Maximum failed task retries**. Before retrying, AUTO-MAS restarts the game. +Once configured, add the script to the [task scheduler queue](/en/docs/task-scheduler) and it runs on its own. Three things worth knowing: -### Log Locations +- **The game may restart repeatedly**: when one user's tasks are split across two different scripts, the game restarts at each switch. That is intentional. It stops the two scripts' states from interfering with each other. +- **Your M7A and SRA configuration is safe**: AUTO-MAS backs it up before running and restores it afterwards. +- **Failures are retried automatically**: retried up to your **Maximum failed task retries**, with a game restart before each retry. -When troubleshooting, provide: +### Which logs to attach when reporting a problem -- `debug/app.log`: AUTO-MAS main process log -- `debug/frontend.log`: frontend log +- `debug/app.log` — the AUTO-MAS main process log +- `debug/frontend.log` — the frontend log -If the issue is related to a specific external script, also include the M7A / SRA runtime log directory. See each script's official documentation for its location. +If it looks like a problem inside one of the scripts, attach that script's own log too. See each script's documentation for where it lives. ## FAQ -### The HSR script type cannot be found +### There is no HSR option when creating a script -- Confirm that your AUTO-MAS version has merged [PR #249](https://github.com/AUTO-MAS-Project/AUTO-MAS/pull/249). -- Restart AUTO-MAS so the frontend OpenAPI client is regenerated. +Your AUTO-MAS is too old to have the HSR script type. Update it from the [download page](/en/download/auto-mas), then restart the app once. -### Path validation fails +### The path is rejected no matter what I enter -- The **March7th path** points to the wrong directory. It must contain `March7th Assistant.exe`. -- The **SRA path** points to the wrong directory. It must contain `SRA-cli.exe`. -- The **Game path** points to the wrong directory. It must contain `StarRail.exe`. -- Note: select the **directory** (folder), not the `exe` file itself. +**You probably selected the exe itself. This field wants the folder.** Check that the exe sits directly in that folder: `March7th Assistant.exe` for M7A, `SRA-cli.exe` for SRA, `StarRail.exe` for the game. Do not pick a subdirectory either. -### Stage list is empty +### The stage list is empty -- Confirm that M7A / SRA has been opened manually once and initialized `config.yaml` / `settings.json`. -- Confirm that the script path points to the external script **root directory**, not a subdirectory. -- If you just switched the execution engine for the **Stamina** module, follow the page notice and reselect stages. +Check in this order: have you opened M7A or SRA manually once (most common), does the path point at the script's root directory, and did you just change which script runs Stamina (if so, reselect your stages). -### Task completion status is unexpected +### Task status is wrong, things run that shouldn't or don't run that should -- Check whether the **Daily Tasks** and **Weekly/Monthly** switches match your expectations. -- Weekly tasks reset by ISO week, and monthly tasks reset by calendar month. State resets automatically after week/month changes. -- Check `debug/app.log` for M7A / SRA subprocess exit codes and marker judgment logs. -- In **Progress and Reset**, you can manually mark completion or reset state to synchronize it. +- Check the task switches on the user page first. +- Weekly tasks reset weekly and monthly tasks reset monthly. State clears automatically at the boundary. +- **Mark Complete** or **Reset** in the **Progress and Reset** area fixes the state immediately. +- Still wrong? Check `debug/app.log`. It records how the scripts exited. -### M7A Divergent Universe seems unstable +### M7A runs Divergent Universe unreliably -- Enable **Low-performance compatibility mode** on the script page. -- Team, blessings, and extrapolation strategy are decided by the M7A client. Configure them in M7A itself in advance. +Turn on **Enable low-performance compatibility mode** on the script page. Team, blessings, and extrapolation strategy are outside AUTO-MAS's control, so set those up in M7A beforehand. -### SRA Currency Wars finishes but there are no points +### SRA finished Currency Wars but there are no points -- This is known behavior. SRA **does not automatically claim points rewards** after Currency Wars completes. Claim them manually in game. +Known behavior. SRA does not claim them, so collect them in game. To skip that step, assign Currency Wars to M7A instead. -### The game restarts repeatedly during scheduling +### The game keeps restarting -- When different modules for the same user are handled by different engines, for example one by M7A and one by SRA, AUTO-MAS restarts the game during engine switches to avoid script state pollution. This is expected. -- To reduce restarts, assign multiple modules to the same engine in TaskMapping. +One user's tasks are split across two different scripts, so the game restarts at each switch. It is intentional, and it keeps the two scripts' states from interfering. If it bothers you, assign all the tasks to one script. -### A task fails but logs show no M7A / SRA output +### A task failed, but there is no script output in the log -- Confirm that Windows Defender or antivirus software did not block the subprocess. -- Confirm that external script paths do not contain Chinese characters, spaces, or symbolic links. -- Add the M7A, SRA, and Honkai: Star Rail installation directories to the antivirus trust list and try again. +The script never started, and that almost always means antivirus blocked it. Add the M7A, SRA, and game directories to your antivirus allowlist and try again. While you are there, confirm the paths contain no non-English characters, spaces, or symbolic links. ## Feedback and Help diff --git a/en/docs/script-guide/index.md b/en/docs/script-guide/index.md index cb85005..0f6e0ba 100644 --- a/en/docs/script-guide/index.md +++ b/en/docs/script-guide/index.md @@ -1,6 +1,8 @@ # Script Management -AUTO-MAS supports managing and scheduling multiple game scripts. This section explains how to use different scripts in AUTO-MAS. +Find the game you play below, open its guide, and follow along. + +Your game is not in the list? See [General Scheduling](/en/docs/script-guide/general). As long as the script can start running a task on startup and writes a log, AUTO-MAS can manage it. ## Guide Index @@ -36,22 +38,20 @@ Reverse: 1999 - M9A Wuthering Waves - OK-WW -- Wuthering Waves project in the ok-script family, configured separately from OkNte for Neverness to Everness -- The MAS entry currently handles DailyTask and MultiAccountDailyTask (`-t 1` and `-t 7`) -- Supports full automatic game lifecycle management in MAS, including startup and shutdown -- Provides Script, User, and Direct control sources, with optional task configuration takeover for high-frequency fields -- Uses only official Wuthering Waves resources and launcher; WeGame is not supported +- Currently supports daily tasks and multi-account dailies +- AUTO-MAS can start and close the game for you +- Complex settings stay in OK-WW's own UI; AUTO-MAS only takes over the high-frequency ones +- Supports the official launcher only, not WeGame --- ### [HSR](/en/docs/script-guide/hsr) -Honkai: Star Rail - HSR specialization, with M7A and SRA dual engines +Honkai: Star Rail - March7thAssistant (M7A) + StarRailAssistant (SRA) -- Supports both March7thAssistant (M7A) and StarRailAssistant (SRA) -- Covers daily Trailblaze Power consumption, reward collection, Divergent Universe, Currency Wars, and more -- Allows the Trailblaze Power, reward, divergent, and currency modules to independently choose M7A or SRA -- Automatically retries failed tasks and avoids polluting external script configuration +- You can mix both scripts and decide which one handles which task +- Covers Trailblaze Power, reward collection, Divergent Universe, and Currency Wars +- Retries failed tasks automatically and will not break your existing script config --- @@ -60,7 +60,7 @@ Honkai: Star Rail - HSR specialization, with M7A and SRA dual engines For scripts that can run tasks on startup and print logs - Supports most mainstream scripts, including March7thAssistant, SRC, zzzOD, and M9A -- Provides ready-made configuration templates for quick setup +- Ready-made config templates you can use straight away - Supports flexible custom script management plans --- @@ -71,14 +71,3 @@ Honkai: Star Rail - March7thAssistant - Under development - Can be used together with automatic login scripts - ---- - -## Reading Recommendations - -- **New users**: start with the [MAA guide](/en/docs/script-guide/maa) if you play Arknights -- **Wuthering Waves players**: read the [OK-WW guide](/en/docs/script-guide/okww) -- **Reverse: 1999 players**: read the [M9A guide](/en/docs/script-guide/m9a) -- **Honkai: Star Rail players**: read the [HSR guide](/en/docs/script-guide/hsr) -- **Other games**: read [General Scheduling](/en/docs/script-guide/general) and use an existing template -- **Advanced users**: learn the configuration management model in [General Scheduling](/en/docs/script-guide/general) and customize your scheduling plan diff --git a/en/docs/script-guide/m9a.md b/en/docs/script-guide/m9a.md index 08922b7..a2b8e73 100644 --- a/en/docs/script-guide/m9a.md +++ b/en/docs/script-guide/m9a.md @@ -1,12 +1,12 @@ # M9A Configuration Guide ::: tip Tip -M9A adaptation is still under development. Bugs may exist during this period. Keep your original general script configuration while using the dedicated script. +M9A support is still under development, so bugs are possible. Keep your existing general script configuration around while you try the dedicated script. ::: ## What is M9A? -M9A is a third-party tool for Reverse: 1999. It can handle repetitive tasks such as daily automation, automatic Artificial Somnambulism, and event farming. +M9A is a third-party tool for Reverse: 1999. It handles repetitive work such as daily automation, Artificial Somnambulism, and event farming. It is powered by [MaaFramework](https://github.com/MaaXYZ/MaaFramework) image recognition technology. @@ -30,51 +30,45 @@ It is powered by [MaaFramework](https://github.com/MaaXYZ/MaaFramework) image re ## Configure the Script 1. Go to **Script Management**, click **New Script**, and select **M9A Script** to add a script instance management page. -2. In the opened script configuration, click **Select folder** for **M9A path**, then open the directory where M9A is located. -3. In **Emulator Management**, select the emulator and emulator instance. +2. In the script configuration that opens, click **Select folder** for **M9A path** and open the directory M9A is in. +3. In **Emulator Management**, select the emulator and the emulator instance. > If no emulator appears here, complete **Emulator Management** configuration first. ### Runtime Configuration -The M9A script provides the following runtime control parameters: - | Configuration | Description | Default | |---------------|-------------|---------| -| Proxy count limit | Maximum automation runs per user per day. `0` means unlimited. | 0 | -| Run count limit | Maximum retry count when a task fails unexpectedly | 3 | -| Runtime limit | Maximum runtime for a single task in minutes. Timeout forces termination. | 10 | -| Auto update after queue ends | After batch tasks complete, automatically update M9A resources if a new version is detected | Disabled | +| Proxy count limit | Maximum automation runs per user per day. `0` means unlimited | 0 | +| Run count limit | How many times a failed task is retried | 3 | +| Runtime limit | Maximum minutes for a single task. It is forced to stop on timeout | 10 | +| Auto update after queue ends | After the queue finishes, update M9A resources if a new version is detected | Disabled | -> Tip: After enabling "Auto update after queue ends", AUTO-MAS starts a virtual user after all real user tasks are completed to update resources. Desktop and Webhook notifications are sent after successful update. -> -> Important: Before using auto update, manually open M9A and separately enable a resource update channel in M9A settings, either MirrorChyan or GitHub. Otherwise auto update cannot work correctly. +::: warning Auto update needs an update channel enabled inside M9A first +**Auto update after queue ends** relies on M9A's own update feature. Open M9A by hand and **enable a resource update channel** in its settings, either MirrorChyan or GitHub. Without that, this switch does nothing. +::: -## Preparation Before First Run +## Required Before the First Run -::: warning Important -Before using M9A in AUTO-MAS for the first time, manually start M9A once and complete the following initialization steps. -::: +Before you use M9A from AUTO-MAS the first time, you **must open M9A by hand once** so it can initialize itself: -1. Manually start the M9A main program, `M9A.exe`. -2. Wait for M9A initialization to complete. After logs show "AgentServer started", wait until "all tasks completed" appears. -3. In M9A settings: - - Configure **resource download source**, choosing MirrorChyan or GitHub. - - Fill in **CDK** or **Token** for resource updates. -4. Decide in M9A whether to enable **auto update** and choose the **update channel**. -5. Close M9A after confirmation. +1. Launch `M9A.exe`. +2. Wait for initialization to finish. The log shows "AgentServer started", then wait for "all tasks completed". +3. In M9A settings, configure the **resource download source** (MirrorChyan or GitHub) and the matching **CDK / Token**. +4. While you are there, decide whether to enable M9A's own **auto update**. That is up to you. +5. Close M9A. -After completing these steps, return to AUTO-MAS and click **Save Configuration**. +Back in AUTO-MAS, click **Save Configuration** and you are ready to go. ## Configure Users 1. In the script table under **Script Management**, click **Add user** to add a user. -2. Fill in user information according to the hints on the settings card. -3. You can add multiple users. AUTO-MAS runs each user's task queue sequentially according to the user list. +2. Fill in the user information following the hints on the settings card. +3. You can add several users. AUTO-MAS runs each user's task queue in the order they appear in the list. ### Task Queue Configuration -M9A supported tasks include, depending on the actual software version: +M9A supports the following tasks, depending on the version you have: | Task | Description | | ---- | ----------- | @@ -87,143 +81,69 @@ M9A supported tasks include, depending on the actual software version: | Bank Shopping | Automatically shop in the bank | | Claim Rewards | Automatically claim various rewards | -On the user configuration page, select tasks from the task list, add them to the task queue, and adjust execution order. +On the user configuration page, pick the tasks you want from the task list, add them to the task queue, and adjust the execution order. ### Preset Template -When the task queue is empty, the system shows the **Daily - Idle** preset template. One click adds common tasks to the queue. - -The **Daily - Idle** template includes the following tasks, suitable for daily farming when no event is active or the event shop has been cleared: - -| Task | Description | -|------|-------------| -| Collect Wilderness | Collect Wilderness resources | -| Daily Psychube, Insight Analysis | Automatically complete insight analysis | -| Regular Battle | Daily stage battles | -| Auto Artificial Somnambulism | Automatically complete Artificial Somnambulism challenges | -| Auto Anecdote | Automatically complete Anecdote | -| Bank Shopping | Automatically shop in the bank | -| Claim Rewards | Automatically claim various rewards | -| Use Redemption Code | Automatically use redemption codes | - -> Tip: Preset templates are only helper entries for quickly adding tasks. You can still manually build task queues through **Add task**, or modify tasks after adding the preset. If some tasks do not have matching script definitions, they are skipped automatically during one-click add. - -### Account Switching - -M9A supports automatic account switching for multi-account management: +Do not feel like adding tasks one at a time? While the task queue is empty, a **Daily - Idle** template appears. One click adds the common tasks: Collect Wilderness, Daily Psychube (Insight Analysis), Regular Battle, Auto Artificial Somnambulism, Auto Anecdote, Bank Shopping, Claim Rewards, and Use Redemption Code. It suits ordinary days with no event running, or when you have already cleared the event shop. -1. Fill in the target account in the **Account information** field on the user configuration page. This works only for the official server. -2. When server resource is **Official server** and account information is provided, AUTO-MAS automatically inserts a **Switch account** task at the beginning of the task queue. -3. The account switching task runs after **Start game** and before user-defined tasks. +You can still add, remove, and reorder tasks afterwards. Any task in the template that your M9A version does not have is skipped automatically. -> Tip: If account switching is not needed, leave account information empty. Other servers do not support account switching for now. +### Automatic Account Switching -### Known Limitations +**Only the official server supports this.** Other servers cannot, because of an M9A limitation. -- Official server: supported, and it is the only server supporting account switching. -- Bilibili server: supported, but account switching is not supported due to M9A limitations. -- Other servers: supported, but account switching is not supported due to M9A limitations. -- MuMu emulator: supported. -- LDPlayer: supported. -- General emulator: untested. -- MXU GUI: not supported. M9A adaptation supports only MFAAvalonia. +Fill in the target account under **Account information** on the user configuration page and you are done. AUTO-MAS then inserts a **Switch account** task at the front of the queue, after Start game and before your own tasks. Leave it empty if you do not need to switch accounts. -## Configuration Notes +### What Is Supported -The following describes AUTO-MAS configuration behavior for M9A in **auto-proxy** mode. +| | Status | +|---|---| +| Official server | Supported, and the only server where accounts switch automatically | +| Bilibili and other servers | Supported, but no automatic account switching (an M9A limitation) | +| MuMu emulator / LDPlayer | Supported | +| Other emulators | Untested, may have problems | +| MXU GUI | Not supported. Only MFAAvalonia is supported | -1. Configuration items shown on the user configuration page take priority. -2. AUTO-MAS automatically builds M9A instance configuration files according to the configured task queue. -3. **Task queue auto-build rules**: - - Automatically add **Start game** at the beginning of the queue. - - If the server is official and account information is provided, automatically insert **Switch account** after **Start game**. - - Automatically filter user-added **Start game**, **Close game**, and **Switch account** tasks to avoid duplication. - - Automatically add **Close game** at the end of the queue. - - Automatically skip standalone tasks marked as `standalone`. - - Final execution order: `Start game -> [Switch account] -> User-defined tasks -> Close game`. -4. **Configuration safety**: - - AUTO-MAS automatically backs up the entire M9A `config` directory before running. - - During execution, only `config/instances/default.json` is modified. - - Your global `config.json` is not modified. - - Original configuration is restored after the task ends. +## Will Your M9A Configuration Get Wrecked? -## Configuration Isolation +No. Before running, AUTO-MAS backs up M9A's whole `config` directory. While running, it touches exactly one file, the instance configuration at `config/instances/default.json`. Your global `config.json` is never modified. When the run ends, the original configuration is put back. -### How It Works +If you want to compare configurations afterwards, every run's actual configuration is kept at `data/script_id/test*.json`, with the last 5 retained. -AUTO-MAS implements a complete configuration isolation mechanism to keep your original M9A configuration safe: +### How the Task Queue Is Built -1. **Backup before run**: back up the entire `config` directory to a temporary path. -2. **Runtime isolation**: modify only the instance configuration file while keeping global configuration unchanged. -3. **Restore after run**: fully restore the original configuration state. +The tasks you arrange in the UI are not handed to M9A as-is. AUTO-MAS fills in both ends: -### Benefits +```text +Start game -> [Switch account] -> your tasks -> Close game +``` -- Configuration safety: no need to worry about configuration pollution. -- Automatic restoration: every run starts from a clean state. -- Debug-friendly: historical configuration backups are saved automatically under `data/script_id/test*.json`. +So two things are not your problem: -## M9A Auto Update +- **Do not add Start game and Close game yourself.** They are added for you. If you add them manually, they get filtered out, so nothing runs twice. +- **Do not add Switch account either.** It is inserted automatically on the official server when account information is filled in. -### Feature Description +## How Auto Update Works -When **Auto update after queue ends** is enabled, AUTO-MAS automatically detects and updates M9A resources after all real user tasks complete: +With **Auto update after queue ends** enabled, the sequence goes like this. While the first user runs, AUTO-MAS glances at the M9A log for a new-version notice. If there is one, it waits until every user has finished, then does one separate update run, with no emulator connected, purely to update resources. When that is done, it sends you a notification with the result. -1. **Version detection**: during the first user run, AUTO-MAS monitors M9A logs and detects whether a new version is available. -2. **Virtual user update**: if a new version is detected, the system starts a virtual user without connecting an emulator, used only for resource update. -3. **Update monitoring**: the update process is monitored in real time for network interruption, HTTP errors, timeout, and other exceptions. -4. **Notifications**: after update succeeds or fails, desktop and Webhook notifications are sent. - -### Update Failure Handling - -If update fails, the system: - -- Records detailed error logs under `data/script_id/`. -- Sends a notification containing the failure reason, such as network interruption or HTTP request failure. -- Keeps the current version and does not affect the next normal run. - -### Notes - -- M9A automatically restarts during update. This is normal. -- Update timeout is 10 minutes. -- Enable auto update only in a stable network environment. +- M9A restarts itself during the update. That is normal. +- The update waits at most 10 minutes. +- Do not enable this on a flaky connection. A failure does not affect your next run, but you waited for nothing. The reason is written to the `data/script_id/` directory and included in the notification. ## FAQ -### Q: Can I add multiple users under one script? - -A: Check your M9A version first. Newer M9A versions support specified account switching, so you can build account switching tasks based on newer M9A. AUTO-MAS supports managing multiple users under one script and runs each user's task queue sequentially. - -### Q: Which emulators are supported? - -A: **MuMu emulator** and **LDPlayer** have been tested. Other emulators are untested and may have compatibility issues. - -### Q: Is the MXU GUI supported? - -A: No. M9A adaptation supports only the **MFAAvalonia** GUI. - -### Q: Will my M9A configuration be modified? - -A: No. AUTO-MAS only modifies `config/instances/default.json` and fully restores your original configuration after the task ends. - -### Q: How do I view previously run configurations for debugging? - -A: Each run configuration is saved to `data/script_id/test*.json`, keeping up to the latest 5 backups. - -### Q: What should I do if task execution fails? - -1. Check emulator connection status during runtime. -2. Check log files to analyze the error reason. -3. Compare historical configurations under `data/script_id/`. +### Can I add multiple users under one script? -### Q: Do I need to manually add "Start game" and "Close game" to the task queue? +Yes. AUTO-MAS runs each user's task queue in list order. Automatic account switching needs a newer M9A version, the kind that supports switching to a specified account, and works only on the official server. -A: No. AUTO-MAS automatically adds **Start game** at the beginning and **Close game** at the end. If you add these tasks manually, the system filters them to avoid duplicate execution. +### A task failed. How do I investigate? -### Q: How does "Auto update after queue ends" work? +In order: check whether the emulator is connected, then look through the log for the error, and if that is still unclear, open `data/script_id/` and compare the configuration this run actually used against the last successful one. -A: After it is enabled, the system checks whether M9A has a new version after all real user tasks complete. If a new version exists, a virtual user is started, without connecting an emulator, to download and apply the latest M9A resource package. A notification is sent after update completes. +### Why isn't the proxy count going up? -### Q: Why did my proxy count not increase? +**The count uses dates in the UTC+4 timezone**, so it can be several hours off from your computer's date. The rollover point is not your local midnight. -A: Proxy count uses the date in the UTC+4 timezone. If the day's count has already reached the **proxy count limit** in script configuration, later users are skipped. The counter resets automatically on the first automation run each day. +Also, once the day's count reaches the **proxy count limit**, later users are skipped outright. The counter resets on the day's first automation run. diff --git a/en/docs/script-guide/maa.md b/en/docs/script-guide/maa.md index 657b998..9912b61 100644 --- a/en/docs/script-guide/maa.md +++ b/en/docs/script-guide/maa.md @@ -78,28 +78,29 @@ Because MAA's **Bilibili server account switching** uses OCR with limited accura With these changes, account switching should become more stable. ::: -### Configuration Notes +### Which MAA Settings Does AUTO-MAS Override? -The following describes AUTO-MAS configuration behavior for MAA in **auto-proxy** mode. +During an auto-proxy run, AUTO-MAS takes over some MAA settings, so whatever you set in MAA is overwritten. Knowing which ones saves you a lot of "but I definitely set that" confusion: -1. Configuration items shown on the user configuration page take priority. -2. In **Annihilation** tasks, only **Start wakeup** and **Use sanity** are enabled. In **Use sanity**, only **Annihilation mode** stage automation is performed, and task configuration is generated automatically from user settings. In **Daily** tasks, tasks enabled in **Task configuration** are enabled, and task order is fixed. -3. **Scheduled execution** remains disabled. **Behavior after task completion**, **behavior after MAA startup**, **MAA minimization settings**, and **update settings** are automatically adjusted according to actual configuration and execution. -4. In **simple** configuration mode, other settings use **MAA global settings**. In **detailed** configuration mode, other settings use the **user-specific configuration**. In task configuration, only the first task of each type takes effect. If no task of that type is found, the default value is used. +- **Options shown on the user configuration page always win.** +- **Annihilation task**: only **Start wakeup** and **Use sanity** are enabled, only annihilation stages are farmed, and the details are generated automatically from your user settings. +- **Daily task**: runs whatever you ticked in **Task configuration**. **The order is fixed and cannot be changed.** +- **Scheduled execution** is force-disabled, because scheduling belongs to the AUTO-MAS queue. Behavior after task completion, behavior after MAA startup, minimization, and update settings are also adjusted automatically. -## Plans +Anything not taken over follows your configuration mode: **simple** mode uses MAA's global settings, **detailed** mode uses that user's own configuration. -With plans, you can customize stage automation by week. - -![plan](/docs/img/advanced-features/plan-1.png) +::: tip Only the First Task of Each Type Is Used +If you queued two tasks of the same type in MAA, for example two **Use sanity** tasks, AUTO-MAS uses only the first one. If there are none, defaults apply. +::: -It is designed to be easy to understand. +## Weekly Plans: Farm Different Stages Each Day -After switching the configuration mode to weekly plan mode, you can decide what to farm at different times. +Want to farm EXP midweek and credits on the weekend? A weekly plan sets stages day by day. -Switching to simplified view provides an editing experience similar to mower. +![plan](/docs/img/advanced-features/plan-1.png) -Then, in the MAA user interface, select the plan in the stage configuration mode. +1. Switch the configuration mode to **weekly plan mode**, then fill in what to farm each day. If the table takes up too much room, switch to **simplified view** for an editing experience similar to mower. +2. Back on the MAA user page, select your plan under **stage configuration mode**. ![plan](/docs/img/advanced-features/plan-2.png) diff --git a/en/docs/script-guide/maaend.md b/en/docs/script-guide/maaend.md index 559cf82..500d9a6 100644 --- a/en/docs/script-guide/maaend.md +++ b/en/docs/script-guide/maaend.md @@ -21,10 +21,9 @@ MaaEnd is a third-party automation tool for Arknights: Endfield. Based on visual 1. Download the archive from or . 2. Extract the MaaEnd archive to any folder. -::: warning Reminder -Do not extract MaaEnd into a path containing Chinese characters to avoid unnecessary errors. - -Like other scripts, MaaEnd must not be placed in the MAS root directory to avoid the risk of accidental deletion. +::: warning Two Places Not to Extract It +- **Not into a path with non-ASCII characters in it.** Those paths cause failures that are hard to diagnose. Use a plain English path like `D:\MaaEnd`. +- **Not inside the AUTO-MAS root directory.** Like other scripts, anything in there risks being deleted by accident. ::: ## Configure the Script @@ -37,23 +36,24 @@ Like other scripts, MaaEnd must not be placed in the MAS root directory to avoid 3. Adjust the following configuration as needed: - | Configuration | Description | + | Configuration | What to enter | | --- | --- | - | **Controller type** | Select the control method. This overrides the setting configured in MaaEnd. We recommend using the PC client. Emulators require an update to v5.4.0 or the public beta to be usable. | - | **Game path (PC)** | Path to the Endfield game executable | - | **Game launch arguments (PC)** | Extra command-line arguments when launching the game. Leave empty if not needed. | - | **Wait time after game startup (PC)** | How many seconds to wait after launching the game before automation starts. Default is 60 seconds. | - | **Close game after task completion** | Whether to close the game automatically after the last user task completes | - | **Proxy timeout limit** | Consider the task timed out if logs do not change for this many minutes. Default is 10 minutes. | - | **Daily proxy count limit** | Maximum number of automation runs per user per day. `0` means unlimited. | - | **Maximum retry count per run** | Maximum retries after automation failure. Default is 3. | + | **Controller type** | PC client or emulator. **The PC client is recommended.** What you pick here overrides the setting inside MaaEnd. | + | **Game path (PC)** | Pick `Endfield.exe`, **not** the Hypergryph launcher | + | **Game launch arguments (PC)** | Leave empty | + | **Wait time after game startup (PC)** | How many seconds to wait after launching the game before automation starts. Default is 60. | + | **Close game after task completion** | Whether to close the game automatically once every user has finished | + | **Proxy timeout limit** | How many minutes without log activity counts as a hang. Default is 10. | + | **Daily proxy count limit** | Maximum runs per user per day. `0` means unlimited. | + | **Maximum retry count per run** | How many times to retry after a failure. Default is 3. | 4. Click **Save Configuration**. -::: info About Emulators +::: warning Using an Emulator? Check the Version First +Two prerequisites when you set the controller type to emulator (ADB): -- **ADB**: controls Android emulators through the ADB protocol. The emulator must be configured in **Emulator Management**. -- Due to a change in the upstream MFW naming rules, you need to update to v5.4.0 or the public beta so that emulator parameters are passed correctly. +- Configure the emulator under **Emulator Management** first, or it won't connect. +- **MaaEnd must be v5.4.0 or the public beta.** Upstream MFW changed its naming rules, and older versions won't receive the emulator parameters AUTO-MAS passes them. ::: ## Configure Users @@ -67,43 +67,56 @@ Like other scripts, MaaEnd must not be placed in the MAS root directory to avoid #### Basic Information -| Configuration | Description | +| Configuration | What to enter | | --- | --- | -| **Username** | Display name used to distinguish accounts | -| **Enabled status** | Whether the user participates in automation. Disabled users are skipped. | -| **Account ID** | Endfield login phone number, 11 digits. Leave empty to skip account switching. | -| **Password** | Endfield login password, stored encrypted. Has no effect. | -| **Configuration source** | `Script-level` uses the script-level MaaEnd configuration; `User-level` uses that user's independent MaaEnd configuration | -| **Take over specific game configuration** | When disabled, the task configuration below is unavailable and automation only runs according to the saved configuration file. | -| **Remaining days** | Remaining valid automation days. `-1` means unlimited. After each successful automation, it decreases by 1. When it reaches 0, the user is skipped. | -| **Notes** | Free-form notes | +| **Username** | A display name you'll recognize | +| **Enabled status** | Disabled users are skipped | +| **Account ID** | Endfield login phone number, 11 digits. Leave it empty to skip switching and use whichever account is already logged in. | +| **Password** | Has no effect right now. You can leave it empty. | +| **Configuration source** | `Script-level` shares one MaaEnd config across all users; `User-level` gives this user its own | +| **Take over specific game configuration** | Turn this on to use the task configuration below. Leave it off to run purely from the saved config file. | +| **Remaining days** | How many days of automation are left. `-1` means unlimited. Each successful run subtracts a day; at 0 the user is skipped. | +| **Notes** | Anything you like | #### Task Configuration -MAS will try to enable/disable tasks according to your settings; tasks that do not exist are skipped. +AUTO-MAS enables and disables tasks in MaaEnd according to your settings. **Tasks your MaaEnd doesn't have are simply skipped** — that isn't an error. ##### Sanity Task Options -Only appears when the sanity task is enabled, allowing you to quickly modify the sanity task within MAS. + +These only appear when the sanity task is enabled. They let you change the sanity task settings without opening MaaEnd. + ![Sanity task](/docs/img/script-guide/maaend/理智任务.png) -::: tip Account Switching Notes -We recommend using "MAS built-in account switching", which generally offers better stability; if it fails, you can also try switching to MaaEnd account switching. MAS will automatically add the account-switching task for you, so you do not need to add it manually. +::: tip Prefer MAS Built-in Account Switching +Of the two methods, **MAS built-in account switching** is generally more stable, so try that first. If switching fails, change to MaaEnd account switching — once you do, AUTO-MAS adds the account-switching task for you, so you don't have to add it inside MaaEnd yourself. ::: ## Skland Automatic Check-In -Migrated to the check-in tool. +This moved to the [Game Check-in tool](/en/docs/advanced-features/game-sign). Configure it there. -### Result Push Explanation +## Extra Result Notifications -If you have enabled mechanism filtering for the matrix farming task, MAS will additionally push the matrix farming results to you. +Turn either of these on and the notification carries an extra report: -If you have enabled gacha count calculation, MAS will additionally push the gacha count calculation results to you. +- **Mechanism filtering on the matrix farming task** - adds the matrix farming results. +- **Gacha count calculation** - adds the gacha count results. ## FAQ -1. Endfield takes a relatively long time to start. We recommend not lowering the default wait time of 60 seconds. -2. Foreground mode fully occupies the mouse. Operating the keyboard or mouse during automation may cause automation to fail. -3. Make sure the game path points to `Endfield.exe`, not the Hypergryph launcher. -4. In fullscreen mode, resolution is determined by monitor resolution settings. Changing it inside the game is meaningless. MaaEnd requires a 16:9 resolution ratio. -5. Do not enable frame interpolation or similar features, as they may cause MaaEnd screenshots to fail. +### A run failed partway through + +Check whether it was one of these: + +- **You were using the computer during the run.** Foreground mode takes over the mouse completely, so touching the keyboard or mouse interrupts it. If you need the machine while it runs, switch to an emulator. +- **You lowered the wait time.** Endfield is slow to start. Don't go below the default 60 seconds — if automation begins before the game finishes loading, it will fail. +- **Frame interpolation or picture enhancement is on.** That breaks MaaEnd's screenshots. Turn it off. + +### How should I set the resolution? + +MaaEnd requires a **16:9** ratio. Note that in fullscreen the actual resolution comes from your **monitor settings**, so changing it inside the game achieves nothing. + +### Which exe is the game path? + +`Endfield.exe`, **not the Hypergryph launcher**. This is the most common mistake. diff --git a/en/docs/script-guide/march7th.md b/en/docs/script-guide/march7th.md index 2905551..22efd1a 100644 --- a/en/docs/script-guide/march7th.md +++ b/en/docs/script-guide/march7th.md @@ -23,10 +23,8 @@ March7thAssistant is a third-party tool for Honkai: Star Rail. It can handle rep 1. Download the archive from , , or . 2. Extract the March7thAssistant archive to any folder. -::: warning Reminder -Do not extract March7thAssistant or other general scripts you need into Chinese-named folders such as **脚本**. - -This helps avoid unnecessary errors. +::: warning Don't Unpack Into a Non-English Path +Keep March7thAssistant, and any other general script, out of folders with non-ASCII characters in the name, such as `D:\脚本\`. Those paths cause failures that are hard to diagnose. Use a plain English path like `D:\M7A`. ::: ### Configure the Script Instance @@ -50,8 +48,8 @@ The script configuration opens shortly: 5. In the opened script configuration, click **Select folder** for **Script root directory**, then open the March7thAssistant software directory. ![AUTO-MAS configuration 5](/docs/img/script-guide/March7thAssistan/AUTO-MAA-5.png) -::: warning Reminder -The script configuration field is automatically corrected after selecting the script root directory. Do not change it casually unless you understand what it does. +::: warning Don't Edit the Paths Below by Hand +Once you pick the script root directory, the paths under **script configuration** are filled in automatically by the template. Leave them alone unless you know what each one does. Wrong values break automation in confusing ways. ::: 6. After selecting the March7thAssistant directory, the **script configuration** path is corrected automatically and does not need manual selection. Click the save button in the lower-right corner. diff --git a/en/docs/script-guide/okww.md b/en/docs/script-guide/okww.md index 30c5602..1067520 100644 --- a/en/docs/script-guide/okww.md +++ b/en/docs/script-guide/okww.md @@ -64,16 +64,16 @@ This prevents one user's quick settings from affecting the next user and prevent - The game path must be the official `launcher.exe`; **WeGame resources and the WeGame launcher are not supported**. - If MAS should not manage game startup and shutdown, disable **Game Configuration**. This does not change the official-resource requirement for OK-WW. -## Startup Tasks Currently Supported +## Which Tasks Can Run Right Now -The MAS OK-WW entry currently takes over only these tasks: +AUTO-MAS handles just these two: -| Index | Arguments | Description | -| --- | --- | --- | -| 1 | `-t 1 -e` | `DailyTask` | -| 7 | `-t 7 -e` | `MultiAccountDailyTask` | +- The **daily task** +- The **multi-account daily task** + +When a task finishes, AUTO-MAS makes OK-WW exit on its own, so there is nothing for you to do. -MAS always appends `-e`, which makes OK-WW exit after the task finishes. For other OK-WW tasks, use the native OK-WW entry instead of selecting an unsupported task index in MAS. +OK-WW's other tasks are not wired up yet. If you need one, open OK-WW and run it there. ## FAQ diff --git a/en/docs/script-guide/sra.md b/en/docs/script-guide/sra.md new file mode 100644 index 0000000..2dce027 --- /dev/null +++ b/en/docs/script-guide/sra.md @@ -0,0 +1,100 @@ +--- +title: StarRailAssistant User Guide +description: Schedule StarRailAssistant in AUTO-MAS +date: 2025-11-08 +--- + +# StarRailAssistant User Guide + +## Schedule StarRailAssistant in AUTO-MAS + +### What is SRA? + +StarRailAssistant is a third-party tool for Honkai: Star Rail. It can handle repetitive tasks such as daily automation and Divergent Universe. + +**For more information, see:** + + + +## Install SRA + +1. Download the archive from , , or . +2. Extract the SRA archive to any folder. + +::: warning Don't Unpack Into a Non-English Path +Keep SRA, and any other general script, out of folders with non-ASCII characters in the name, such as `D:\脚本\`. Those paths cause failures that are hard to diagnose. Use a plain English path like `D:\SRA`. +::: + +## Configure the Script Instance + +SRA can manage multiple accounts on its own, and so can AUTO-MAS. That gives you two routes. **Pick one — don't set up both**: + +| | What manages the accounts | Good if | +| --- | --- | --- | +| **Method 1** | AUTO-MAS | You want per-account results inside AUTO-MAS, and want to start or stop individual accounts | +| **Method 2** | SRA | You already have several accounts configured in SRA and don't want to redo them | + +See the [comparison diagram](#differences) at the bottom of this page for how the two differ. + +### Method 1: Use AUTO-MAS Multi-User + +1. Open **AUTO-MAS**, go to **Script Management**, click **New Script**, and select **General Script** to add a script instance management page. + ![SRA configuration 1](/docs/img/script-guide/March7thAssistan/AUTO-MAA-1.png) +2. In the popup, select **Create from template**, then click **OK**. + ![SRA configuration 2](/docs/img/script-guide/March7thAssistan/AUTO-MAA-2.png) +3. In the new window, find and select the **StarRailAssistant** template for SRA v2.14 and above, then click **Use this template**. +4. The script configuration opens shortly: + ![SRA configuration 3](/docs/img/script-guide/sra/mas1.png) +5. In the opened script configuration, click **Select folder** for **Script root directory**, then open the SRA software directory. + ![SRA configuration 4](/docs/img/script-guide/sra/mas2.png) + ::: warning Don't Edit the Paths Below by Hand + Once you pick the script root directory, the paths under **script configuration** are filled in automatically by the template. Leave them alone unless you know what each one does. Wrong values break automation in confusing ways. + ::: +6. After selecting the SRA directory, the **script configuration** paths are corrected automatically and need no manual selection. + ![SRA configuration 5](/docs/img/script-guide/sra/mas3.png) +7. SRA uses `C:\Users\YourName\AppData\Roaming\SRA` as its default config directory, so you don't need to change the **config file path** field. + ![SRA configuration 6](/docs/img/script-guide/sra/mas4.png) +8. The script configuration saves automatically. Leave the script configuration page. +9. Click **Add user** and give the user a name in the username field — it's only a label. Then click **General Configuration** in the upper-right corner. + ![SRA configuration 7](/docs/img/script-guide/sra/mas5.png) +10. This launches the SRA window, where you configure SRA itself. + ::: warning Keep the Config File Named `Default` + When you use AUTO-MAS multi-user, do not rename the config file. Leave it as the default `Default`. + ::: + ![SRA configuration 8](/docs/img/script-guide/sra/sra1.png) +11. When you're done, click the arrow to the right of the start button on the SRA home page to expand the launch options, then select **Save config only**. + ![SRA configuration 9](/docs/img/script-guide/sra/sra2.png) +12. After clicking **Save config only**, close the SRA window and click the save configuration button in AUTO-MAS. That completes one user. + ![SRA configuration 10](/docs/img/script-guide/sra/sra3.png) +13. To add more users, repeat steps 9 to 12. You may notice that SRA loads the previous config file when it opens at step 10 — that's normal. Just change the settings for the new user. + ::: warning Same Rule for Every User + Keep the config file named `Default` for all of them. + ::: + +### Method 2: Use SRA Multi-User + +Steps 1 to 7 are the same as Method 1. From step 8 on, they differ. + +8. Change **launch arguments** to `-e task run`. This makes SRA run every config it has saved on startup, instead of just one. + ![Change launch arguments](/docs/img/script-guide/sra/mas6.png) +9. The configuration saves automatically. Leave the script configuration page. +10. Click **Add user** and give the user a name in the username field — it's only a label. Then click **General Configuration** in the upper-right corner. + ![SRA configuration 7](/docs/img/script-guide/sra/mas5.png) +11. This launches the SRA window, where you configure SRA itself. + You can use the `Default` config file as-is. If you have several accounts, create the new configs **inside SRA** and switch to each one to edit it. + ![SRA configuration 8-1](/docs/img/script-guide/sra/sra4.png) + ![SRA configuration 8-2](/docs/img/script-guide/sra/sra5.png) + ![SRA configuration 8-3](/docs/img/script-guide/sra/sra6.png) +12. After finishing each config, click the arrow to the right of the start button on the SRA control panel to expand the launch options, then select **Save config only**. + ![SRA configuration 9](/docs/img/script-guide/sra/sra2.png) +13. Once every config is saved, close the SRA window and click the save configuration button in AUTO-MAS. All users are now configured. + +### Differences + +One diagram covers it: + +![Comparison](/docs/img/script-guide/sra/compare.png) + +In short: with Method 1, AUTO-MAS swaps in one user's config at a time and launches SRA for each round. With Method 2, AUTO-MAS launches SRA once and SRA works through all of its own configs. diff --git a/en/docs/task-scheduler.md b/en/docs/task-scheduler.md index 29475ad..90e3a29 100644 --- a/en/docs/task-scheduler.md +++ b/en/docs/task-scheduler.md @@ -2,58 +2,47 @@ ## Scheduling Queues -A **scheduling queue** is the AUTO-MAS module that organizes script tasks. It can define the run order for **multiple scripts**, run tasks automatically when the app starts, and run tasks on a schedule. +A **scheduling queue** is a to-do list: you put the scripts you want to run into it in order, and AUTO-MAS works down the list one script at a time. You can also have it start running when the app launches, or at set times. -::: warning Reminder -Scheduling queues run scripts in sequence, which means the next script starts only after the previous script finishes. +::: warning Two things to get straight first +**Scripts in a queue run one after another.** The next one starts only after the previous one finishes. If you see several scripts running at the same time, check your general script settings. -If scripts in a single queue appear to run in parallel, check the general script settings. - -Different start times in the same queue are not per-script start times. - -Running a queue starts all scripts in that queue. - -If you plan to use this feature, read this document carefully before asking questions. +**A queue can have several scheduled times, but those times don't belong to individual scripts.** At each scheduled time, the whole queue runs from the top. They are not "run script A at this time, script B at that time". ::: ![scheduler](/docs/img/advanced-features/scheduler.png) ### Usage -1. Click **New Queue** in the upper-right corner to create a queue. -2. Enable **Run on startup** and/or **Scheduled run** according to your needs. - -::: tip Tips -You can set AUTO-MAS to start with Windows and enable **Run on startup** in the scheduling queue. This lets scripts for emulators, such as MAA, run automatically when you start your computer. +1. Click **New Queue** in the upper-right corner. +2. Turn on **Run on startup** or **Scheduled run** as needed. +3. Click **Add schedule** and set the time. **Remember to switch the scheduled run status to Enabled**, or it won't fire. +4. Click **Add task** and add scripts you have already configured to the queue. If there's nothing to choose from here, you haven't configured any scripts yet. Start with [Script Configuration](/en/docs/script-guide/). -If you have a machine that never stops, you can enable scheduled runs and let AUTO-MAS perform automation at the selected times. - -If you have special login requirements, such as MAA custom infrastructure tasks, you can start MAA automatically before the custom infrastructure takes effect so MAA can switch infrastructure layouts. +::: tip Three common setups +- **Run everything at boot**: set AUTO-MAS to start with Windows and enable **Run on startup** on the queue. It finishes the batch after boot with nothing from you. +- **Run at set times**: if your computer stays on, use **Scheduled run** to pick a few times for it to run on its own. +- **Pair with MAA custom infrastructure**: schedule MAA to start shortly before an infrastructure layout takes effect, so MAA swaps the shift over while it's there. ::: -3. Click **Add schedule** and set the time when scripts should run. Remember to change the scheduled run status to **Enabled**. -4. Add tasks. A **task** here refers to a script task already configured in **Script Management**. If no tasks are available, read [Script Configuration](/en/docs/script-guide/). - -## Auto-Proxy Strategy +## Run order in auto-proxy mode -The following describes AUTO-MAS task scheduling behavior in **auto-proxy** mode. +In **auto-proxy** mode, tasks are nested like this: -- Each **user** contains two subtasks: **Annihilation** and **Daily**. In simple mode, **Daily** is enabled by default. The app does not check whether the same user is running elsewhere. Scheduling order: **Annihilation > Daily**. This item applies only to MAA scripts. -- Each **script instance** contains multiple users. A **script instance task** is the sum of all tasks for its users. The same **script instance** cannot be started repeatedly. If it is already running, a new **script instance task** will be skipped. Scheduling order: **ascending user index**. -- Each **scheduling queue** contains multiple **script instance tasks**. A **scheduling queue task** is the sum of all **script instance tasks** in its task queue. The same **scheduling queue** can be started repeatedly. Scheduling order: **ascending task instance index**. -- Each **scheduler console** can run and display one **scheduling queue task**. Create multiple **scheduler consoles** to run multiple queues. +- **One user** = all the tasks that user has selected. For MAA scripts, a user's tasks split into **Annihilation** and **Daily**, with Annihilation first; simple mode has Daily on by default. +- **One script** = the tasks of all users under it, run in the order the users appear in the list. The same script can't run twice at once. If it's already running, starting it again is skipped. +- **One queue** = the tasks of all scripts in the queue, run in queue order. The same queue can be started more than once. +- **One scheduler console** runs one queue at a time. To run several queues in parallel, open more consoles. ## Manual Review -**Manual review** is a mode for checking user automation status. It reviews users one by one and records the review result. - -::: info Help me, developer - -Currently only MAA is supported. More may come later. +The batch has finished, but you want to see with your own eyes whether each account really got everything done. That's what **manual review** is for: AUTO-MAS logs in to each account in turn, you take a look, and it records the result. +::: info Only MAA is supported for now +Other scripts aren't supported yet. ::: -- Select **Manual review mode**, then click **Start task**. -- The app starts MAA and logs in to each user account in order. -- **After PRTS login completes**, manually check the automation status and confirm unfinished tasks. -- After the review ends, the system records the result in the status information section on the **User Management** page. +1. Select **Manual review mode** and click **Start task**. +2. The app starts MAA and logs in to each account in order. +3. **After each PRTS login finishes**, check that account's run yourself and manually confirm anything that didn't get done. +4. When the review ends, the results are recorded in the status information on the **User Management** page. diff --git a/en/docs/user-guide.md b/en/docs/user-guide.md index f95bd64..19a6f35 100644 --- a/en/docs/user-guide.md +++ b/en/docs/user-guide.md @@ -1,42 +1,43 @@ # Getting Started -## Prerequisites +## What is AUTO-MAS? -### What is AUTO-MAS? +AUTO-MAS is a manager for your scripts. The scripts you would otherwise start one at a time (MAA, for example) get handed to it instead: it swaps account configs for you, launches the scripts in order, and watches their logs to tell a finished run from a hang. -**AUTO-MAS** is a log-monitoring based multi-script, multi-configuration management and automation tool. It controls other script programs, such as MAA, by modifying configuration files and listening to logs, making multi-account automation easier to manage. +In short, it runs your whole multi-account batch in one go. > AUTO-MAS: Make ALL Scripts Auto -## Usage +## Installation -### Install AUTO-MAS +### Download and install -1. Go to the [download page](/en/download/auto-mas) and get the latest installer package. -2. Install according to the package type: - - Installer package: extract the archive and run `AUTO-MAS-Setup.exe`, then follow the installation wizard. - - Portable package: extract the archive to the target install location, then run `AUTO-MAS.exe` to start the app. +1. Go to the [download page](/en/download/auto-mas) and get the latest package. +2. Install it according to the package type: + - Installer: extract the archive and run `AUTO-MAS-Setup.exe`, then follow the installer. + - Portable: extract the archive to wherever you want it installed, then run `AUTO-MAS.exe` to start the app. -::: tip Choosing a Package +::: tip What those words in the filename mean -Some download channels allow you to choose the package type. +Some download channels offer several packages. Pick by filename: -- **Installer and portable packages** - - Packages with `setup` in the name are installer packages and can be installed by running the installer. - - Packages without `setup` are portable packages and can be used after extracting them to the install location. - -- **Full and lite packages** - - Packages with `full` in the name include most dependencies and usually start faster on first launch. - - Packages with `lite` in the name do not include dependencies. Dependencies will be downloaded and installed automatically on first launch. +| Filename contains | What it means | Pick it when | +| --- | --- | --- | +| `setup` | Installer, run it and follow the prompts | You want the installer to handle the install location for you | +| no `setup` | Portable, extract and run | You want to choose where it goes, or move the whole folder later | +| `full` | Dependencies already bundled | Your connection is slow and you would rather not wait on first launch | +| `lite` | Downloads dependencies on first launch | You want a smaller download | ::: -### Trust the App +### Add it to your antivirus allowlist (important, don't skip this) + +Automation scripts click constantly and read and write config files, so antivirus software easily mistakes them for malware and deletes them. Before your first run, add the `AUTO-MAS install directory` and `each script's install directory` to Windows Defender exclusions. If you use third-party antivirus software, add them to its trusted list too. -Before running AUTO-MAS, add the `AUTO-MAS installation directory` and the `script software installation directory` to Windows Defender exclusions and to the trusted/developer directory of any antivirus software. The following steps show how to add Windows Defender exclusions: +Here is how to **add Windows Defender exclusions**: Quick link: -1. If another antivirus program is installed, enable **Periodic scanning** first. +1. If you have another antivirus program installed, turn on **Periodic scanning** first. ![Windows Defender configuration 1](/docs/img/WD-1.png) 2. **Virus & threat protection settings > Manage settings** @@ -45,26 +46,28 @@ Quick link: 3. **Exclusions > Add or remove exclusions** ![Windows Defender configuration 3](/docs/img/WD-3.png) -4. **Add an exclusion > Select the corresponding directory** +4. **Add an exclusion > Select the matching directory** ![Windows Defender configuration 4](/docs/img/WD-4.png) -5. If another antivirus program is installed, disable **Periodic scanning** again. +5. **If you have another antivirus program installed, turn Periodic scanning back off.** + +*That one surely doesn't need a screenshot.* -::: warning Note -Even if another antivirus program is installed, such as Huorong or 360 Extreme Edition, **Windows Defender** may still enable its protection from time to time. This can cause `AUTO-MAS.exe` or other script executables to disappear unexpectedly. Make sure the directories above are excluded in **Windows Defender**. +::: warning Do this even if you already have another antivirus +Even with another antivirus program installed, **Windows Defender** can still switch its real-time protection back on by itself, and then your `AUTO-MAS.exe` or one of your script executables quietly disappears. So the directories above have to be excluded in Defender. ::: -## Initialization +## First launch -When AUTO-MAS starts, it automatically initializes software dependencies and updates backend code. +The first launch takes a while: AUTO-MAS is downloading the dependencies it needs and updating the backend code to the latest version. Let it finish. -If `Settings -> Update Configuration -> Automatically check for updates` is enabled, AUTO-MAS will check dependencies and update the backend every time it starts. +After that, if `Settings -> Update Configuration -> Automatically check for updates` is on, it checks again on every start. Fixes usually ship through the backend first, so **when something breaks, restarting the app has often already fixed it**. Try that first. -Backend updates allow AUTO-MAS to deliver some fixes quickly. Restart the app to receive these fixes as soon as possible. +## What to configure next -## Configure the App +Almost every setting in the app comes with a note next to it. Work through each page top to bottom and you are basically done. If you get stuck, come back to the matching section of these docs. -Most AUTO-MAS pages include inline notes. You can follow the hints inside the app to complete configuration. After going through every page once, you will likely have finished most setup. If you run into configuration issues, return to the relevant documentation page. +Two things worth remembering for when something goes wrong: -- **Configuration backup**: AUTO-MAS stores configuration files in the `data` and `config` folders under the app installation root, and stores history in the `history` folder. Back up these folders to restore configuration data later. -- **Runtime logs**: AUTO-MAS stores backend logs in `debug/app.log` and frontend logs in `debug/frontend.log` under the app installation root. Providing these logs helps developers locate issues quickly. +- **To back up or move your configuration**: copy the `data` and `config` folders (configuration) and the `history` folder (run history) from the install directory. That is all you need. +- **To report an error to the developers**: the logs are at `debug/app.log` (backend) and `debug/frontend.log` (interface) in the install directory. Attach both when you ask, and you save a round trip. diff --git a/en/index.md b/en/index.md index 4053ed0..789b087 100644 --- a/en/index.md +++ b/en/index.md @@ -4,7 +4,7 @@ layout: home hero: name: "AUTO-MAS" text: "Multi-account game script management and automation" - tagline: "Improve script multi-account workflows and automation stability" + tagline: "Run all your accounts without babysitting them" image: src: /icons/AUTO-MAS.ico alt: "AUTO-MAS Logo" @@ -26,22 +26,25 @@ hero: link: /en/docs/FAQ features: - - title: Centralized Management - details: Manage multiple scripts and user profiles from one place. - - title: Unattended Operation - details: Monitor script logs and handle failures during automated tasks. - - title: Flexible Configuration - details: Combine scheduling queues and scripts to model different automation workflows. - - title: Execution Records - details: Keep task records and log snippets for faster troubleshooting. + - title: One window for every account + details: Configs for all your scripts and all your accounts live in one place. No more juggling a dozen windows. + - title: It handles the hangs for you + details: It watches script logs the whole time and retries when a script errors out or freezes. Runs fine while you are away from the computer. + - title: You decide when it runs + details: Put scripts in a scheduling queue, then run them on app startup or at set times. + - title: You can tell what went wrong + details: Every run keeps its result and the key log lines, so you can see which account failed at which step. --- ## Why AUTO-MAS? -**AUTO-MAS** is a game script management tool focused on improving multi-account script workflows and automation stability. +If you run several accounts, you know how this goes: editing script configs one by one, a script hanging halfway with nobody watching, and finding out the next day that one account got skipped without knowing why. + +**AUTO-MAS** takes that work off your hands. It does not replace MAA, M9A, or any other script. It drives them: swaps configs for you, launches them in order, watches their logs to tell a finished run from a hang, retries what failed, and records the results. + +- **Reliable**: it watches logs and handles errors as they happen, so tasks actually finish instead of only looking finished. +- **Less work**: no hand-editing config files. A few clicks in the interface covers it. +- **Works with almost anything**: any automation script fits, as long as it starts running on launch and writes logs. -- **Efficient and stable**: uses log monitoring, exception handling, and related mechanisms to help automation tasks complete reliably. -- **Simple to use**: configure automation scheduling and multi-instance management in the visual interface without manually editing configuration files. -- **Compatible and extensible**: supports almost any automation tool as long as it can start a task from launch arguments and print logs. Free code signing provided by [SignPath.io](https://signpath.io/), certificate by [SignPath Foundation](https://signpath.org/) diff --git a/index.md b/index.md index 8e69557..b32eba4 100644 --- a/index.md +++ b/index.md @@ -27,23 +27,25 @@ hero: link: /docs/FAQ features: - - title: 集中管理 - details: 一站式管理多个脚本与多个用户配置，和凌乱的散装脚本窗口说再见！ - - title: 无人值守 - details: 监看脚本日志并自动处理报错，再也不用为代理任务卡死时自己不在电脑旁烦恼啦！ - - title: 配置灵活 - details: 通过调度队列与脚本的组合设计调度队列，自由实现您能想到的所有调度需求！ - - title: 代理记录 - details: 记录所有代理记录与日志片段，定位问题更快更准更方便！ + - title: 一个界面管所有号 + details: 多个脚本、多个账号的配置都在一处，不用再开一堆窗口来回切。 + - title: 卡住了它自己会处理 + details: 全程盯着脚本日志，发现报错或卡死就重试。人不在电脑旁也能跑完。 + - title: 什么时候跑你说了算 + details: 用调度队列排好顺序，开机自动跑或定时自动跑，随你安排。 + - title: 出问题查得到 + details: 每次代理的结果和关键日志都留档，哪个号哪一步出错一目了然。 --- ## 为什么选择 AUTO-MAS？ -**AUTO-MAS** 是一个游戏脚本管理工具，专注于优化 **各种脚本** 多账号功能的使用体验，并增强代理的稳定性。 +如果你有好几个号要代理，你大概经历过这些：一个个手动改脚本配置、跑到一半卡住了没人管、第二天发现某个号漏了但不知道为什么。 -- **高效稳定**：通过日志监测、异常处理等机制，保障代理任务顺利完成。 -- **简洁易用**：无需手动修改配置文件，在可视界面实现自动化调度与多开管理。 -- **兼容扩展**：支持几乎所有自动化软件，仅要求支持启动时运行任务并能够打印日志。 +**AUTO-MAS** 就是来接这些活的。它不替代 MAA、M9A 这些脚本，而是管着它们：替你切换配置、按顺序启动、盯着日志判断成功还是卡死、失败了重试、结果记账。 + +- **稳**：全程监看日志并处理异常，尽量让任务真的跑完，而不是看起来跑完了。 +- **省事**：不用手动改配置文件，界面上点几下就行。 +- **通吃**：几乎所有自动化脚本都能接，只要它能"启动后自动开跑"并且会写日志。 Free code signing provided by [SignPath.io](https://signpath.io/), certificate by [SignPath Foundation](https://signpath.org/)