Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

<!-- README.md 和 README.en.md 逐节对应:改了其中一份,请在同一个 PR 里把另一份也改了。 -->

[ModAVD(魔改 AVD)](https://github.com/ModAVD/ModAVD) 的文档站源码,发布在 <https://modavd.github.io/>(英文版在 <https://modavd.github.io/en/>)。用 [VitePress](https://vitepress.dev/) 编译。
[ModAVD](https://github.com/ModAVD/ModAVD) 的文档站源码,发布在 <https://modavd.github.io/>(英文版在 <https://modavd.github.io/en/>)。用 [VitePress](https://vitepress.dev/) 编译。

- 页面是 `docs/` 下的 Markdown,中文是主语言;英文页在 `docs/en/` 下,路径和中文页一一对应。导航和侧边栏在 `docs/.vitepress/config.mts`,两种语言用同一张页面表。
- 每页底部有「在 GitHub 上改这一页」,改完提 PR 就行。写法见站内的「参与开发 → 文档和本站」。
Expand Down
2 changes: 1 addition & 1 deletion docs/components/bridge.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ x86_64 镜像靠 Google 的转译层跑 arm64 应用:系统库保持原生 x86
## 装进实例

- **0.36.0 起不用自己装**:用管理器 `ModAVD.exe` 或命令行 `tools\modavd.exe start` 开机时,新建的和已有的实例都会自动带好桥。开机流程做完后桥还没装就装上,没生效就关机冷启动,最多三轮。第一次开机要多 1–2 分钟。
- 装好以后照常用 AUTO-MAS 开机,桥一直在。
- 装好以后照常开机就行(管理器、命令行或 AUTO-MAS 都可以),桥一直在。
- 只用 AUTO-MAS 开机、从没用管理器开过的实例,这一版还不会自动装:用管理器把它开一次机就行。
- 桥装在实例自己的 system / vendor 覆盖层里,不动 Google 的原始镜像。

Expand Down
2 changes: 1 addition & 1 deletion docs/develop/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ issue、PR、评论和提交说明用中文或英文都可以。
维护者只在一台 Windows 11、AMD CPU、NVIDIA 独显的电脑上测过。最缺这些配置的实测:Intel CPU,AMD 或 Intel 显卡,笔记本双显卡,Windows 10,16 GB 内存。

1. 照[安装](../guide/install)装好,在管理器里建一台实例、开机,装上你玩的游戏玩一会儿;用 AUTO-MAS 的,在 AUTO-MAS 里添加,跑一轮日常任务。
2. 在管理器的「设置 → 组件与问题反馈」里点「复制配置信息」(或运行 `tools\modavd.exe report-config`),在 ModAVD 仓库的 [Issues](https://github.com/ModAVD/ModAVD/issues) 新开 issue,贴上它,补完最后三行,再写一句能不能跑。0.38.1 及更早的包里是包根的「复制配置信息.bat」。
2. 在管理器的「设置 → 组件与问题反馈」里点「复制配置信息」(或运行 `tools\modavd.exe report-config`),在 ModAVD 仓库的 [Issues](https://github.com/ModAVD/ModAVD/issues) 新开 issue,贴上它,补完最后两行,再写一句能不能跑。0.38.1 及更早的包里是包根的「复制配置信息.bat」。

这份输出不带用户名、电脑名、完整路径和游戏账号,可以直接公开贴。详见[游戏实测和兼容性报告](./testing)。

Expand Down
2 changes: 1 addition & 1 deletion docs/develop/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ ModAVD 是 AOSP Android Emulator 加一批补丁,WHPX 加速,gfxstream 渲
好几个分区的验证都要开实例。数字来自 ModAVD 的说明和维护者机器上的实测:

- **CPU**:x86_64,BIOS 里开着虚拟化(Intel VT-x / AMD SVM)。安卓能用的虚拟 CPU 最多是电脑逻辑处理器数的一半,所以给实例 4 核要 8 个线程,6 核要 12 个线程。
- **内存**:实例内存可选 3 / 4 / 5 / 6 GB(AUTO-MAS 默认 6 GB),开机时电脑还要再空出约 1.5 GB;模拟器自身另占约 0.6–0.75 GB。
- **内存**:实例内存可选 3 / 4 / 5 / 6 GB(默认 6 GB),开机时电脑还要再空出约 1.5 GB;模拟器自身另占约 0.6–0.75 GB。
- **硬盘**:放在 NTFS 盘上。组件和模拟器本体共约 5 GB(补全组件时要 6.5 GB 可用);每台实例第一次开机,所在的盘要有 10 GB 以上可用,不装游戏的新实例实际只占约 1.1 GB。装了游戏的实例要几十 GB,见[游戏实测](./testing)。

## 现在正在做的
Expand Down
4 changes: 2 additions & 2 deletions docs/develop/testing.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@

## 协助者最容易帮上的

在你自己的电脑上照[安装](../guide/install)装好,在 AUTO-MAS 里跑一轮日常,然后:
在你自己的电脑上照[安装](../guide/install)装好,建一台实例,装上要测的游戏玩一会儿(用 AUTO-MAS 的,在 AUTO-MAS 里跑一轮日常),然后:

1. 在管理器的「设置 → 组件与问题反馈」里点「复制配置信息」,或运行 `tools\modavd.exe report-config`;
2. 在 ModAVD 仓库的 [Issues](https://github.com/ModAVD/ModAVD/issues) 新开 issue,贴上它,补完最后三行;
2. 在 ModAVD 仓库的 [Issues](https://github.com/ModAVD/ModAVD/issues) 新开 issue,贴上它,补完最后两行;
3. 再写一句能不能跑。

最缺这些配置:Intel CPU、AMD 或 Intel 显卡、笔记本双显卡、Windows 10、16 GB 内存。兼容性报告最想要的反而是低配机器,只要满足[适用环境](../guide/#适用环境)就欢迎来测。
Expand Down
2 changes: 1 addition & 1 deletion docs/en/components/bridge.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ A game's hardening library redirects the entry points of some functions in the s
## Installing into an instance

- **From 0.36.0 you do not need to install it yourself**: when you start an instance with the manager `ModAVD.exe` or the CLI `tools\modavd.exe start`, both new and existing instances get the bridge automatically. If the bridge is not installed after the startup sequence finishes, it is installed; if it does not take effect, the instance is shut down and cold-booted, up to three rounds. The first boot takes 1–2 minutes longer.
- Once it is installed, start instances with AUTO-MAS as usual; the bridge stays in place.
- Once it is installed, start instances as usual (from the manager, the CLI or AUTO-MAS); the bridge stays in place.
- An instance that has only ever been started by AUTO-MAS and never by the manager is not installed automatically in this version: start it once with the manager.
- The bridge is installed in the instance's own system / vendor overlay and does not touch Google's original image.

Expand Down
2 changes: 1 addition & 1 deletion docs/en/develop/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ If this is your first time, look at the issues labeled [good first issue](https:
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), create an instance in the manager, start it, install a game you play and play for a while. If you use AUTO-MAS, add the instance there and run one round of daily tasks.
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.
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 two 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).

Expand Down
2 changes: 1 addition & 1 deletion docs/en/develop/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ For how to take part (credit, licensing, how to submit), [Contributing to ModAVD
Verification in several areas needs a running instance. The numbers come from ModAVD's documentation and from measurements on the maintainer's machine:

- **CPU**: x86_64, with virtualization turned on in the BIOS (Intel VT-x / AMD SVM). Android can use at most half of the computer's logical processors as virtual CPUs, so an instance with 4 cores needs 8 threads, and 6 cores need 12 threads.
- **RAM**: Instance memory can be 3 / 4 / 5 / 6 GB (AUTO-MAS defaults to 6 GB). At boot the computer needs about another 1.5 GB free, and the emulator itself takes about 0.6–0.75 GB more.
- **RAM**: Instance memory can be 3 / 4 / 5 / 6 GB (6 GB by default). At boot the computer needs about another 1.5 GB free, and the emulator itself takes about 0.6–0.75 GB more.
- **Disk**: On an NTFS drive. The components and the emulator itself take about 5 GB together (6.5 GB must be free when fetching the Google components). The drive of each instance needs 10 GB or more free on its first boot; a new instance with no games installed actually takes only about 1.1 GB. An instance with games installed takes tens of GB; see [Testing on real games](./testing).

## What is in progress
Expand Down
4 changes: 2 additions & 2 deletions docs/en/develop/testing.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@

## The easiest way to help

Install on your own computer by following [Installation](../guide/install), run one round of daily tasks in AUTO-MAS, and then:
Install on your own computer by following [Installation](../guide/install), create an instance, install the game you want to test and play it for a while (if you use AUTO-MAS, run one round of daily tasks in it), and then:

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;
2. Open an issue in the [ModAVD repository](https://github.com/ModAVD/ModAVD/issues), paste it, and fill in the last two 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.
Expand Down
4 changes: 2 additions & 2 deletions docs/en/guide/feedback.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Open an issue in the [Issues](https://github.com/ModAVD/ModAVD/issues) of the Mo
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. Generate the report, in one of two ways:
- In the manager: open `ModAVD.exe`, click **设置** (Settings), then **组件与问题反馈** (Components and feedback), then **收集问题信息** (Collect a problem report). The report also goes to your desktop. When it finishes, it shows its path, a button **在资源管理器里显示** (Show in File Explorer) that opens its folder, and a privacy note.
- On the command line: run `tools\modavd.exe collect-info`. After about a minute, a `魔改AVD问题信息-<time>.zip` (the name means "ModAVD problem info") appears on the desktop and is selected in File Explorer automatically (add `--no-explorer` to skip that).
- On the command line: run `tools\modavd.exe collect-info`. After about a minute, a `ModAVD-问题信息-<time>.zip` (问题信息 means "problem info") appears on the desktop and is selected in File Explorer automatically (add `--no-explorer` to skip that).

In packages 0.38.1 and earlier this was `收集问题信息.bat` in the package root. From 0.38.2 that file is gone.

Expand Down Expand Up @@ -55,4 +55,4 @@ When 补全组件 (Fetch components) fails, attaching `logs\fetch-components.log

## Tell us when it works, too

If a round of daily tasks runs through on your computer, click **复制配置信息** (Copy configuration info) under **设置 → 组件与问题反馈** (Settings → Components and feedback) in the manager, or run `tools\modavd.exe report-config`. The configuration info is copied to the clipboard and shown on screen. Open an issue in the [ModAVD repository](https://github.com/ModAVD/ModAVD/issues) and paste it. Fill in the last three lines and add a sentence saying whether it works. This output has no user name, computer name, full paths or game accounts, so you can post it publicly as it is. See [Testing on real games and compatibility reports](../develop/testing).
If a game works on your computer (or a round of daily tasks runs through), click **复制配置信息** (Copy configuration info) under **设置 → 组件与问题反馈** (Settings → Components and feedback) in the manager, or run `tools\modavd.exe report-config`. The configuration info is copied to the clipboard and shown on screen. Open an issue in the [ModAVD repository](https://github.com/ModAVD/ModAVD/issues) and paste it. Fill in the last two lines and add a sentence saying whether it works. This output has no user name, computer name, full paths or game accounts, so you can post it publicly as it is. See [Testing on real games and compatibility reports](../develop/testing).
2 changes: 1 addition & 1 deletion docs/en/guide/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ A Release package is made of several parts, each developed in its own repository
| CPU | x86_64 (Intel / AMD), with virtualization turned on in the BIOS (Intel VT-x / AMD SVM) |
| Windows feature | Windows Hypervisor Platform (WHPX) |
| GPU | A discrete GPU or a recent integrated GPU with Vulkan support |
| Memory | AUTO-MAS gives each instance 6 GB by default, and the PC needs about 1.5 GB more free when an instance boots |
| Memory | Each instance gets 6 GB by default (3–6 GB can be chosen), and the PC needs about 1.5 GB more free when an instance boots |
| Disk | Put it on an NTFS drive. Fetching the components needs about 6.5 GB free. Each instance needs more than 10 GB free on its first boot, then grows with game data, usually tens of GB per game |
| Path | A path with only English letters and digits, for example `D:\ModAVD` |
| AUTO-MAS | `v5.7.0` or newer is recommended. From v5.7.0-beta.5, MAA and MFW scripts (MaaFramework projects, such as M9A) work; other scripts are not supported yet. The Release notes list what each version supports |
Expand Down
2 changes: 1 addition & 1 deletion docs/en/guide/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ The steps below are the same for both ways. Only the interface differs.
- System image Android 14 (API 34) Google APIs x86_64 r14, about 1.5 GB, about 4.2 GB after extraction.
4. With the automatic choice it tries the mirrors in order: googledownloads.cn → Tencent Cloud mirror → dl.google.com. If one is unreachable or fails the check, it moves on to the next.
5. After each file is downloaded, it checks the size and SHA-1 and extracts the file only if they match. If the download is interrupted, click **补全组件** again or run the command again and it resumes.
6. Done. In the manager, the item shows the progress (bytes downloaded, percentage, speed, time left) and a **取消** (Cancel) button while it runs, and the check runs again by itself when it finishes. The command line prints 完成,可以在 AUTO-MAS 里添加这个文件夹了。 (Done. You can now add this folder in AUTO-MAS.)
6. Done. In the manager, the item shows the progress (bytes downloaded, percentage, speed, time left) and a **取消** (Cancel) button while it runs, and the check runs again by itself when it finishes. The command line prints 完成,可以新建实例了;用 AUTO-MAS 的,也可以在 AUTO-MAS 里添加这个文件夹了。 (Done. You can now create instances; if you use AUTO-MAS, you can also add this folder there.)

Components that are already installed are skipped, so running it again has no side effects. The process is logged in `logs\fetch-components.log`.

Expand Down
4 changes: 2 additions & 2 deletions docs/guide/feedback.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
1. **出问题后先别关模拟器。** 实例还开着的话,收集时会顺带记下当时的画面和状态。
2. 生成问题包,两种做法:
- 在管理器里:打开 `ModAVD.exe`,点「设置」,再点「组件与问题反馈」,点「收集问题信息」。问题包同样放在桌面上,做完会显示它的路径,点「在资源管理器里显示」打开它所在的文件夹,并显示隐私提示。
- 用命令行:运行 `tools\modavd.exe collect-info`。大约一分钟,桌面上会生成 `魔改AVD问题信息-<时间>.zip`,并自动在资源管理器里选中它(加 `--no-explorer` 就不打开)。
- 用命令行:运行 `tools\modavd.exe collect-info`。大约一分钟,桌面上会生成 `ModAVD-问题信息-<时间>.zip`,并自动在资源管理器里选中它(加 `--no-explorer` 就不打开)。

0.38.1 及更早的包里是包根的「收集问题信息.bat」,双击运行;0.38.2 起这个文件没有了。

Expand Down Expand Up @@ -55,4 +55,4 @@

## 能跑起来也欢迎说一声

在你的电脑上跑通了一轮日常的话,在管理器的「设置 → 组件与问题反馈」里点「复制配置信息」(或运行 `tools\modavd.exe report-config`),配置信息会复制到剪贴板并显示出来。在 ModAVD 仓库的 [Issues](https://github.com/ModAVD/ModAVD/issues) 新开 issue,贴上它,补完最后三行,再写一句能不能跑。这份输出不带用户名、电脑名、完整路径和游戏账号,可以直接公开贴。见[游戏实测和兼容性报告](../develop/testing)。
游戏在你的电脑上能正常玩(或者跑通了一轮日常)的话,在管理器的「设置 → 组件与问题反馈」里点「复制配置信息」(或运行 `tools\modavd.exe report-config`),配置信息会复制到剪贴板并显示出来。在 ModAVD 仓库的 [Issues](https://github.com/ModAVD/ModAVD/issues) 新开 issue,贴上它,补完最后两行,再写一句能不能跑。这份输出不带用户名、电脑名、完整路径和游戏账号,可以直接公开贴。见[游戏实测和兼容性报告](../develop/testing)。
4 changes: 2 additions & 2 deletions docs/guide/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# 这是什么

ModAVD(魔改 AVD)是基于 AOSP Android Emulator 37.2.10 的安卓模拟器,加了一批补丁后自己编译。目前支持 Windows,以后计划支持更多平台(见 [#27](https://github.com/ModAVD/ModAVD/issues/27))。
ModAVD是基于 AOSP Android Emulator 37.2.10 的安卓模拟器,加了一批补丁后自己编译。目前支持 Windows,以后计划支持更多平台(见 [#27](https://github.com/ModAVD/ModAVD/issues/27))。

包里带管理器 `ModAVD.exe` 和命令行 `tools\modavd.exe`,用来建实例、开机关机;也可以接入 [AUTO-MAS](https://github.com/AUTO-MAS-Project/AUTO-MAS) 这类自动化工具,由它们负责实例编排和任务流程。

Expand Down Expand Up @@ -34,7 +34,7 @@ ModAVD(魔改 AVD)是基于 AOSP Android Emulator 37.2.10 的安卓模拟器
| CPU | x86_64(Intel / AMD),BIOS 里开着虚拟化(Intel VT-x / AMD SVM) |
| Windows 功能 | 「Windows 虚拟机监控程序平台」(WHPX) |
| 显卡 | 支持 Vulkan 的独立显卡或较新的集成显卡 |
| 内存 | AUTO-MAS 默认每台实例 6 GB,开机时电脑要再空出约 1.5 GB |
| 内存 | 每台实例默认 6 GB(可选 3–6 GB),开机时电脑要再空出约 1.5 GB |
| 硬盘 | 放在 NTFS 盘。补全组件时要约 6.5 GB 可用;每台实例第一次开机要 10 GB 以上可用,之后随游戏数据增长,一个游戏通常几十 GB |
| 路径 | 只含英文、数字的路径,例如 `D:\ModAVD` |
| AUTO-MAS | 推荐 `v5.7.0` 或更新。v5.7.0-beta.5 起 MAA 和 MFW 脚本(MaaFramework 项目,如 M9A)可以用,其他脚本暂不支持;各版本的支持情况见 Release 说明 |
Expand Down
Loading