diff --git a/docs/develop/adapt-game.md b/docs/develop/adapt-game.md index 41933d4..9a78e50 100644 --- a/docs/develop/adapt-game.md +++ b/docs/develop/adapt-game.md @@ -19,7 +19,7 @@ - 启动前 `logcat -c`，再 `logcat -b all -v threadtime > 启动.txt`，然后启动游戏，复现以后停。 - 崩了的话，取 `/data/tombstones/` 里最新的那份：`shell su 0 ls -t /data/tombstones`。 -- 模拟器日志在根目录的 `logs\` 里。「收集问题信息.bat」会把日志一起打包。 +- 模拟器日志在根目录的 `logs\` 里。「收集问题信息」会把日志一起打包。 - 重点看这几样： - `Fatal signal`：崩在哪个库、哪个线程； - `FATAL EXCEPTION`； @@ -54,7 +54,7 @@ ## 第五步：适配好以后 {#after} -- 在 ModAVD 仓库的 [Issues](https://github.com/ModAVD/ModAVD/issues) 新开 issue，附上「复制配置信息.bat」的输出，记下游戏、渠道、版本、怎么跑起来的、帧率大概多少。 +- 在 ModAVD 仓库的 [Issues](https://github.com/ModAVD/ModAVD/issues) 新开 issue，附上「复制配置信息」的输出，记下游戏、渠道、版本、怎么跑起来的、帧率大概多少。 - 有自动化脚本、又有不耗资源的任务的，维护者会把它加进发版回归，并存下帧率基准。 ## 规矩 diff --git a/docs/develop/index.md b/docs/develop/index.md index 85a8280..f8b9dce 100644 --- a/docs/develop/index.md +++ b/docs/develop/index.md @@ -9,14 +9,14 @@ ModAVD 只有一个维护者，回复可能要几天。大一点的改动请先 维护者只在一台 Windows 11、AMD CPU、NVIDIA 独显的电脑上测过。最缺这些配置的实测：Intel CPU，AMD 或 Intel 显卡，笔记本双显卡，Windows 10，16 GB 内存。 1. 照[安装](../guide/install)装好，在 AUTO-MAS 里添加，开机后跑一轮日常任务。 -2. 双击文件夹里的「复制配置信息.bat」（0.35.0 起包里有），在 ModAVD 仓库的 [Issues](https://github.com/ModAVD/ModAVD/issues) 新开 issue，附上输出，补完最后三行，再写一句能不能跑。 +2. 在管理器的「设置 → 组件与问题反馈」里点「复制配置信息」（或运行 `tools\modavd.exe report-config`），在 ModAVD 仓库的 [Issues](https://github.com/ModAVD/ModAVD/issues) 新开 issue，贴上它，补完最后三行，再写一句能不能跑。0.38.1 及更早的包里是包根的「复制配置信息.bat」。 这份输出不带用户名、电脑名、完整路径和游戏账号，可以直接公开贴。详见[游戏实测和兼容性报告](./testing)。 ## 报问题 - 各组件的问题都在 ModAVD 仓库的 [Issues](https://github.com/ModAVD/ModAVD/issues) 提：模拟器本体，也包括管理器和命令行、宿主输入法、本站、发版前回归。开 issue 时选上是哪个组件。 -- 附「收集问题信息.bat」生成的问题包。哪些能公开贴、崩溃转储怎么私下发，见[反馈问题](../guide/feedback)。 +- 附「收集问题信息」生成的问题包（管理器的「设置 → 组件与问题反馈」，或 `tools\modavd.exe collect-info`）。哪些能公开贴、崩溃转储怎么私下发，见[反馈问题](../guide/feedback)。 - 贴日志前，把路径里的 `C:\Users\<你的用户名>` 换成 `%USERPROFILE%`。 - AUTO-MAS 的界面、任务、调度问题，请到 [AUTO-MAS](https://github.com/AUTO-MAS-Project/AUTO-MAS/issues) 提。 - 安全问题不要公开发，请发邮件到 qiyinxi@foxmail.com。 diff --git a/docs/develop/overview.md b/docs/develop/overview.md index fce6f67..ab4ceb7 100644 --- a/docs/develop/overview.md +++ b/docs/develop/overview.md @@ -12,7 +12,7 @@ ModAVD 是 AOSP Android Emulator 加一批补丁，WHPX 加速，gfxstream 渲 | [arm64 执行桥](./bridge) | ModAVD 的 `bridge/` | C++（NDK） | 高 | 不能 | Opus 5.5 / GPT-6 Astra | | [管理器和命令行](./manager) | [ModAVDManager](https://github.com/ModAVD/ModAVDManager) | Go，页面是原生 JS / CSS | 中 | 单元测试、构建、可复现核对 | Sonnet 5.5 / GPT-6.1 Sol；开机流程、并发、整包更新用 Opus 5.5 / GPT-6 Astra | | [宿主输入法](./ime) | [ModAVDHostIME](https://github.com/ModAVD/ModAVDHostIME) | Java（Android） | 中低 | 协议自测、APK 构建、发布核对 | Sonnet 5.5 / GPT-6.1 Sol | -| [随包脚本](./package) | ModAVD 的 `package/` | PowerShell、批处理 | 中低 | 隐私扫描 | Sonnet 5.5 / GPT-6.1 Sol | +| [随包脚本](./package) | ModAVD 的 `package/` | PowerShell | 中低 | 隐私扫描 | Sonnet 5.5 / GPT-6.1 Sol | | 发版前回归（端到端测试） | [ModAVDE2E](https://github.com/ModAVD/ModAVDE2E) | PowerShell、Python | 中 | 语法解析、隐私扫描；回归本身不跑 | Sonnet 5.5 / GPT-6.1 Sol | | [文档和本站](./docs) | 本站仓库 [modavd.github.io](https://github.com/ModAVD/modavd.github.io)，各仓库的 README | Markdown | 低 | 编译站点、查死链、隐私扫描 | Sonnet 5.5 / GPT-6.1 Terra；机械改动用 Haiku 5.5 / GPT-6 Luna | | [AUTO-MAS 对接](./automas) | [AUTO-MAS](https://github.com/AUTO-MAS-Project/AUTO-MAS) | Python、前端 | 中 | 按 AUTO-MAS 自己的 CI | Sonnet 5.5 / GPT-6.1 Sol；审查用 Opus 5.5 / GPT-6 Astra | diff --git a/docs/develop/package.md b/docs/develop/package.md index fd290d4..56c71b3 100644 --- a/docs/develop/package.md +++ b/docs/develop/package.md @@ -1,23 +1,28 @@ # 随包脚本 -**改什么**：随 ModAVD 包发的脚本，在 ModAVD 仓库的 [`package/`](https://github.com/ModAVD/ModAVD/tree/main/package)。三个 `.bat` 放在包的根目录，四个 `.ps1` 放在包的 `tools\` 里，和包里发出的文件逐字节相同。 +**改什么**：随 ModAVD 包发的脚本，在 ModAVD 仓库的 [`package/`](https://github.com/ModAVD/ModAVD/tree/main/package)。0.38.2 起只剩 `modavd-bridge.ps1`，放在包的 `tools\` 里，和包里发出的文件逐字节相同。 + +补全组件、收集问题信息、复制配置信息不再是脚本。0.38.1 及更早的包里，包根有三个 `.bat`，调 `tools\` 下的 `fetch-components.ps1`、`collect-info.ps1`、`report-config.ps1`；0.38.2 起这六个文件都不发了，三件事全在管理器和命令行里。要改它们，到 [ModAVDManager](https://github.com/ModAVD/ModAVDManager) 提 PR，见[管理器和命令行](./manager)。 | 文件 | 做什么 | 从哪一版起在包里 | | --- | --- | --- | -| `补全组件.bat` → `fetch-components.ps1` | 先显示 Google《Android 软件开发套件许可协议》，同意后从官方渠道下载 adb 和系统镜像，校验 SHA-1 后装进 `sdk\`；能断点续传，镜像按顺序回落 | 37.2.10-mas30 | -| `收集问题信息.bat` → `collect-info.ps1` | 在桌面生成问题包，见[反馈问题](../guide/feedback) | 37.2.10-mas30 | -| `复制配置信息.bat` → `report-config.ps1` | 把电脑配置和各实例装的游戏包整理成一段文字，复制到剪贴板，在 [Issues](https://github.com/ModAVD/ModAVD/issues) 新开 issue 反馈时附上 | 0.35.0 | | `modavd-bridge.ps1` | 给一台实例装上、卸掉或核对 arm64 执行桥，见[开发：arm64 执行桥](./bridge#怎么装进实例) | 0.36.0 | +原来三个 `.bat` 做的事，现在这样做： + +| 以前 | 现在：管理器 | 现在：命令行 | +| --- | --- | --- | +| `补全组件.bat` | 顶栏「电脑检查」里「组件」一项下的「补全组件」，或缺组件时主页横幅上的「补全组件」；先选下载源，读 Google《Android 软件开发套件许可协议》，同意后下载 adb 和系统镜像，校验 SHA-1 后装进 `sdk\`，能断点续传 | `tools\modavd.exe components fetch`；下载源用 `components source` 看和改 | +| `收集问题信息.bat` | 「设置 → 组件与问题反馈 → 收集问题信息」，生成问题包，见[反馈问题](../guide/feedback) | `tools\modavd.exe collect-info` | +| `复制配置信息.bat` | 同一处的「复制配置信息」：把电脑配置和各实例装的游戏包整理成一段文字，复制到剪贴板，在 [Issues](https://github.com/ModAVD/ModAVD/issues) 新开 issue 反馈时附上 | `tools\modavd.exe report-config` | + ## 写法上的规矩 - 要在 Windows 自带的 PowerShell 5.1 上也能跑，用户机器上默认是它： - `.ps1` 存成 UTF-8 带 BOM； - - `.bat` 里只用 ASCII，换行用 CRLF； - `.gitattributes` 让这个目录原样保存，不做换行转换。提 PR 时请保持文件原来的换行和 BOM，仓库里的字节就是发布包里的字节。 - 不硬编码本机路径；adb 只走 ModAVD 根目录 `mas-avd.json` 里的私有端口，不碰 5037。 - 重启、关机前先 `adb shell sync`，再结束模拟器。 -- 输出给用户贴到公开 issue 的内容，不能带用户名、电脑名、完整路径、游戏账号。 ## 硬件 @@ -31,7 +36,7 @@ ## 验证 -在 Windows 10 / 11、不同系统语言下，用 PowerShell 5.1 各跑一遍。 +在 Windows 10 / 11、不同系统语言下，用 PowerShell 5.1 跑一遍 `modavd-bridge.ps1`。 ## 交付 diff --git a/docs/develop/testing.md b/docs/develop/testing.md index 06c8304..bec6c47 100644 --- a/docs/develop/testing.md +++ b/docs/develop/testing.md @@ -4,8 +4,8 @@ 在你自己的电脑上照[安装](../guide/install)装好，在 AUTO-MAS 里跑一轮日常，然后： -1. 双击「复制配置信息.bat」； -2. 在 ModAVD 仓库的 [Issues](https://github.com/ModAVD/ModAVD/issues) 新开 issue，附上输出，补完最后三行； +1. 在管理器的「设置 → 组件与问题反馈」里点「复制配置信息」，或运行 `tools\modavd.exe report-config`； +2. 在 ModAVD 仓库的 [Issues](https://github.com/ModAVD/ModAVD/issues) 新开 issue，贴上它，补完最后三行； 3. 再写一句能不能跑。 最缺这些配置：Intel CPU、AMD 或 Intel 显卡、笔记本双显卡、Windows 10、16 GB 内存。兼容性报告最想要的反而是低配机器，只要满足[适用环境](../guide/#适用环境)就欢迎来测。 diff --git a/docs/en/develop/adapt-game.md b/docs/en/develop/adapt-game.md index 73f6d43..0bb5171 100644 --- a/docs/en/develop/adapt-game.md +++ b/docs/en/develop/adapt-game.md @@ -19,7 +19,7 @@ To get a game that currently will not start or runs badly working on ModAVD, wor - Before launching, run `logcat -c`, then `logcat -b all -v threadtime > 启动.txt`, then launch the game, and stop once it reproduces. - If it crashed, take the newest file in `/data/tombstones/`: `shell su 0 ls -t /data/tombstones`. -- The emulator logs are in `logs\` in the root folder. `收集问题信息.bat` (collects a problem report) packs the logs together. +- The emulator logs are in `logs\` in the root folder. **收集问题信息** (Collect a problem report) packs the logs together. - Look mainly at these: - `Fatal signal`: which library and which thread it crashed in; - `FATAL EXCEPTION`; @@ -54,7 +54,7 @@ Try approaches that need no recompiling first, and settle the direction before y ## Step 5: After it works {#after} -- Open an issue in the [ModAVD repository](https://github.com/ModAVD/ModAVD/issues). Include the output of `复制配置信息.bat`, the game, channel, version, how you got it running, and roughly what frame rate it gets. +- Open an issue in the [ModAVD repository](https://github.com/ModAVD/ModAVD/issues). Include the output of **复制配置信息** (Copy configuration info), the game, channel, version, how you got it running, and roughly what frame rate it gets. - If the game has an automation script and tasks that do not use many resources, the maintainer will add it to the pre-release regression tests and record a frame-rate baseline. ## Rules diff --git a/docs/en/develop/index.md b/docs/en/develop/index.md index e2a30ab..b5fd5ee 100644 --- a/docs/en/develop/index.md +++ b/docs/en/develop/index.md @@ -9,14 +9,14 @@ To see what environment and hardware each area needs, and which models to pick w The maintainer has tested on only one computer: Windows 11, AMD CPU, NVIDIA discrete GPU. What is missing most is testing on these configurations: Intel CPU, AMD or Intel GPU, laptops with dual GPUs, Windows 10, and 16 GB of RAM. 1. Install by following [Installation](../guide/install), add the instance in AUTO-MAS, start it, and run one round of daily tasks. -2. Double-click `复制配置信息.bat` (copies your system and game info) in the folder (it is in the package from 0.35.0). Open an issue in the [ModAVD repository](https://github.com/ModAVD/ModAVD/issues) and include the output. Fill in the last three lines and add one sentence on whether it runs. +2. Click **复制配置信息** (Copy configuration info) under **设置 → 组件与问题反馈** (Settings → Components and feedback) in the manager, or run `tools\modavd.exe report-config`. Open an issue in the [ModAVD repository](https://github.com/ModAVD/ModAVD/issues) and paste it. Fill in the last three lines and add one sentence on whether it runs. In packages 0.38.1 and earlier this was `复制配置信息.bat` in the package root. This output does not contain your user name, computer name, full paths or game accounts, so you can post it publicly as it is. For details, see [Testing on real games and compatibility reports](./testing). ## Reporting problems - Problems with every component go to the [Issues](https://github.com/ModAVD/ModAVD/issues) of the ModAVD repository: the emulator itself, and also the manager and CLI, the host IME, this site and the pre-release regression tests. Pick the component when you open the issue. -- Attach the problem report made by `收集问题信息.bat` (collects a problem report). For what you can post publicly and how to send crash dumps privately, see [Reporting problems](../guide/feedback). +- Attach the problem report made by **收集问题信息** (Collect a problem report), in **设置 → 组件与问题反馈** in the manager or with `tools\modavd.exe collect-info`. For what you can post publicly and how to send crash dumps privately, see [Reporting problems](../guide/feedback). - Before you paste logs, replace `C:\Users\` in paths with `%USERPROFILE%`. - Problems with AUTO-MAS's interface, tasks or scheduling belong to [AUTO-MAS](https://github.com/AUTO-MAS-Project/AUTO-MAS/issues). - Do not report security problems publicly. Send an e-mail to qiyinxi@foxmail.com. diff --git a/docs/en/develop/overview.md b/docs/en/develop/overview.md index d2add6f..d4dd4a9 100644 --- a/docs/en/develop/overview.md +++ b/docs/en/develop/overview.md @@ -12,7 +12,7 @@ For how to take part (credit, licensing, how to submit), [Contributing to ModAVD | [arm64 execution bridge](./bridge) | `bridge/` of ModAVD | C++ (NDK) | High | Nothing | Opus 5.5 / GPT-6 Astra | | [The manager and CLI](./manager) | [ModAVDManager](https://github.com/ModAVD/ModAVDManager) | Go; the pages are plain JS / CSS | Medium | Unit tests, build, reproducible-build check | Sonnet 5.5 / GPT-6.1 Sol; Opus 5.5 / GPT-6 Astra for the boot flow, concurrency and package updates | | [The host IME](./ime) | [ModAVDHostIME](https://github.com/ModAVD/ModAVDHostIME) | Java (Android) | Medium to low | Protocol self-test, APK build, release check | Sonnet 5.5 / GPT-6.1 Sol | -| [Bundled scripts](./package) | `package/` of ModAVD | PowerShell, batch | Medium to low | Privacy scan | Sonnet 5.5 / GPT-6.1 Sol | +| [Bundled scripts](./package) | `package/` of ModAVD | PowerShell | Medium to low | Privacy scan | Sonnet 5.5 / GPT-6.1 Sol | | Pre-release regression tests (end-to-end tests) | [ModAVDE2E](https://github.com/ModAVD/ModAVDE2E) | PowerShell, Python | Medium | Syntax parsing, privacy scan; the regression run itself is not run | Sonnet 5.5 / GPT-6.1 Sol | | [Documentation and this site](./docs) | This site's repository [modavd.github.io](https://github.com/ModAVD/modavd.github.io), and the READMEs of the repositories | Markdown | Low | Builds the site, checks dead links, privacy scan | Sonnet 5.5 / GPT-6.1 Terra; Haiku 5.5 / GPT-6 Luna for mechanical changes | | [AUTO-MAS integration](./automas) | [AUTO-MAS](https://github.com/AUTO-MAS-Project/AUTO-MAS) | Python, front end | Medium | AUTO-MAS's own CI | Sonnet 5.5 / GPT-6.1 Sol; Opus 5.5 / GPT-6 Astra for review | diff --git a/docs/en/develop/package.md b/docs/en/develop/package.md index bd55e3d..4e88542 100644 --- a/docs/en/develop/package.md +++ b/docs/en/develop/package.md @@ -1,27 +1,32 @@ # Bundled scripts -**What you change**: the scripts that ship in the ModAVD package, in [`package/`](https://github.com/ModAVD/ModAVD/tree/main/package) of the ModAVD repository. The three `.bat` files go in the root of the package and the four `.ps1` files in the package's `tools\` folder. They are byte-identical to the files shipped in the package. +**What you change**: the scripts that ship in the ModAVD package, in [`package/`](https://github.com/ModAVD/ModAVD/tree/main/package) of the ModAVD repository. From 0.38.2 only `modavd-bridge.ps1` is left, in the package's `tools\` folder. It is byte-identical to the file shipped in the package. + +Fetching the components, collecting a problem report and copying the configuration info are no longer scripts. In packages 0.38.1 and earlier, the package root has three `.bat` files that call `fetch-components.ps1`, `collect-info.ps1` and `report-config.ps1` under `tools\`. From 0.38.2 none of these six files ship, and the three jobs are all in the manager and the CLI. To change them, send a PR to [ModAVDManager](https://github.com/ModAVD/ModAVDManager); see [Manager and CLI](./manager). | File | What it does | In the package since | | --- | --- | --- | -| `补全组件.bat` (fetches the Google components) → `fetch-components.ps1` | First shows Google's Android Software Development Kit License Agreement. After you agree, it downloads adb and the system image from the official channels, checks the SHA-1 and installs them into `sdk\`. It can resume downloads and falls back to the next mirror in order | 37.2.10-mas30 | -| `收集问题信息.bat` (collects a problem report) → `collect-info.ps1` | Makes a problem report on the desktop; see [Reporting problems](../guide/feedback) | 37.2.10-mas30 | -| `复制配置信息.bat` (copies your system and game info) → `report-config.ps1` | Puts the computer's configuration and the game packages installed in each instance into one block of text and copies it to the clipboard, to include in a new issue in [Issues](https://github.com/ModAVD/ModAVD/issues) | 0.35.0 | | `modavd-bridge.ps1` | Installs, removes or checks the arm64 execution bridge on an instance; see [Development: arm64 execution bridge](./bridge#installing-into-an-instance) | 0.36.0 | +What the three `.bat` files did is now done like this: + +| Before | Now: the manager | Now: the CLI | +| --- | --- | --- | +| `补全组件.bat` (fetches the Google components) | **补全组件** under the **组件** item in **电脑检查** (Computer check) in the top bar, or on the banner of the home page when components are missing. Choose a download source and read Google's Android Software Development Kit License Agreement; after you agree, it downloads adb and the system image, checks the SHA-1 and installs them into `sdk\`. It can resume downloads | `tools\modavd.exe components fetch`; use `components source` to see and change the download source | +| `收集问题信息.bat` (collects a problem report) | **设置 → 组件与问题反馈 → 收集问题信息** (Settings → Components and feedback → Collect a problem report) makes the report; see [Reporting problems](../guide/feedback) | `tools\modavd.exe collect-info` | +| `复制配置信息.bat` (copies your system and game info) | **复制配置信息** in the same place puts the computer's configuration and the game packages installed in each instance into one block of text and copies it to the clipboard, to include in a new issue in [Issues](https://github.com/ModAVD/ModAVD/issues) | `tools\modavd.exe report-config` | + ## Writing rules - They must also run on the Windows PowerShell 5.1 that ships with Windows, because it is the default on users' machines: - save `.ps1` files as UTF-8 with BOM; - - use only ASCII in `.bat` files, with CRLF line endings; - `.gitattributes` makes this directory store files as they are, with no line-ending conversion. When you send a PR, keep the file's original line endings and BOM: the bytes in the repository are the bytes in the release package. - No hard-coded local paths. adb goes only through the private port in `mas-avd.json` in the ModAVD root folder and never touches 5037. - Before restarting or shutting down, run `adb shell sync` first, then end the emulator. -- Output that users paste into public issues must not contain user names, computer names, full paths or game accounts. ## Hardware -To run them for real on an installed ModAVD, you need to start an instance: +To run it for real on an installed ModAVD, you need to start an instance: | | Recommended | Minimum | |---|---|---| @@ -31,7 +36,7 @@ To run them for real on an installed ModAVD, you need to start an instance: ## Verification -Run each script with PowerShell 5.1 on Windows 10 and 11, and under different system languages. +Run `modavd-bridge.ps1` with PowerShell 5.1 on Windows 10 and 11, and under different system languages. ## Delivery diff --git a/docs/en/develop/testing.md b/docs/en/develop/testing.md index 90e382a..939b210 100644 --- a/docs/en/develop/testing.md +++ b/docs/en/develop/testing.md @@ -4,8 +4,8 @@ Install on your own computer by following [Installation](../guide/install), run one round of daily tasks in AUTO-MAS, and then: -1. Double-click `复制配置信息.bat` (copies your system and game info); -2. Open an issue in the [ModAVD repository](https://github.com/ModAVD/ModAVD/issues), include the output, and fill in the last three lines; +1. Click **复制配置信息** (Copy configuration info) under **设置 → 组件与问题反馈** (Settings → Components and feedback) in the manager, or run `tools\modavd.exe report-config`; +2. Open an issue in the [ModAVD repository](https://github.com/ModAVD/ModAVD/issues), paste it, and fill in the last three lines; 3. Add one sentence on whether it runs. These configurations are missing most: Intel CPU, AMD or Intel GPU, laptops with dual GPUs, Windows 10, and 16 GB of RAM. For compatibility reports, low-end machines are in fact the most wanted. As long as you meet the [requirements](../guide/#requirements), you are welcome to test. diff --git a/docs/en/guide/feedback.md b/docs/en/guide/feedback.md index 93a74c0..51aa690 100644 --- a/docs/en/guide/feedback.md +++ b/docs/en/guide/feedback.md @@ -8,9 +8,13 @@ Open an issue in the [Issues](https://github.com/ModAVD/ModAVD/issues) of the Mo ## 1. Collect a problem report 1. **Do not shut down the emulator after something goes wrong.** If the instance is still running, the collection also records the screen and state at that moment. -2. Double-click `收集问题信息.bat` (collects a problem report) in the folder. After about a minute, a `魔改AVD问题信息-