diff --git a/docs/en/guide/index.md b/docs/en/guide/index.md index c72b9ae..55981b3 100644 --- a/docs/en/guide/index.md +++ b/docs/en/guide/index.md @@ -37,7 +37,7 @@ A Release package is made of several parts, each developed in its own repository | 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 | +| AUTO-MAS (optional) | If you manage instances with AUTO-MAS, check the release notes for your ModAVD version to find a compatible AUTO-MAS version | ## Disclaimer diff --git a/docs/en/guide/install.md b/docs/en/guide/install.md index 879882b..4677eec 100644 --- a/docs/en/guide/install.md +++ b/docs/en/guide/install.md @@ -1,12 +1,11 @@ # Install -This guide uses AUTO-MAS as the example. None of the steps needs administrator rights, except turning on the Windows feature. +You can install and use ModAVD with the bundled manager. Administrator rights are only needed to turn on the Windows feature. ## Check before you start - Windows 10 / 11, 64-bit. The CPU is an Intel or AMD x86_64. - The GPU supports Vulkan (a discrete GPU or a recent integrated GPU). -- AUTO-MAS: `v5.7.0` or newer is recommended. From v5.7.0-beta.5 it supports MAA and all MFW scripts. For earlier versions, see the Release notes. - Find an NTFS drive with plenty of space: - Fetching the components needs about 6.5 GB free. Once installed, the components and the emulator itself take about 5 GB together. - On each instance's first boot, the drive it sits on needs more than 10 GB free. @@ -14,9 +13,9 @@ This guide uses AUTO-MAS as the example. None of the steps needs administrator r ## 1. Download and extract -Download `ModAVD--win-x64.zip` from [Releases](https://github.com/ModAVD/ModAVD/releases) (the examples below use `0.36.0`). +Download `ModAVD--win-x64.zip` from the [latest release](https://github.com/ModAVD/ModAVD/releases/latest). -The zip has no outer folder. Right-click it and choose Extract All, or in 7-Zip choose `Extract to ModAVD-0.36.0-win-x64\`, to get the `ModAVD-0.36.0-win-x64` folder. Do not choose `Extract Here`, or the files end up loose in the folder that holds the zip. +The zip has no outer folder. Right-click it and choose Extract All, or use 7-Zip to extract it to a folder named after the zip. Do not choose `Extract Here`, or the files end up loose in the folder that holds the zip. Put it at a path that contains **only English letters and digits**. You can rename it, for example `D:\ModAVD`. @@ -96,31 +95,32 @@ The emulator needs Windows Hypervisor Platform: If it still does not work, CPU virtualization is most likely turned off in the BIOS. Enter the BIOS and turn on Intel VT-x or AMD SVM. See your motherboard manual for where to find it. -## 4. Add it in AUTO-MAS +## 4. Create and start an instance + +Double-click `ModAVD.exe` in the extracted folder and click **新建实例** (Create instance). Once it is ready, click **开机** (Start) on the instance card to open the emulator window. For commands, see [The manager and the CLI](../components/manager). + +### Connect AUTO-MAS (optional) + +Check the release notes for your ModAVD version to find a compatible AUTO-MAS version. 1. Open **模拟器管理** (Emulator Management). 2. If you have no emulator configuration yet, click **手动添加模拟器** (Add emulator manually) and set the emulator type to **自动识别(推荐)** (Auto-detect (recommended)). If you already have such a configuration, use it. 3. In that configuration click **管理模拟器** (Manage emulators) → **添加魔改 AVD(内测)** (Add ModAVD (beta)), choose the folder you extracted in step 1, and click **检查** (Check). -4. When all the computer checks pass, click **添加** (Add). The first instance is created automatically after it is added. +4. When all the computer checks pass, click **添加** (Add). You can now manage the instances in this folder from AUTO-MAS. If an item under **检查** (Check) does not pass, follow the hint. If virtualization does not pass, see the previous section. -::: tip Without AUTO-MAS -Double-click `ModAVD.exe` in the package root to open the manager, where you can create instances, start and stop them, and watch the screen. For how to use the CLI `tools\modavd.exe`, see [The manager and the CLI](../components/manager). -::: - ## 5. First use -Every new instance must be started by hand once, to install the game and log in: +To play a game, install it and sign in from the emulator window first: -1. In the device list, click the start button of the instance. A manual start shows the emulator window. -2. In the window, swipe up from the bottom to open the app list, use Chrome to download the game's Android installer from its official website, and install it. If the system says installing unknown apps is not allowed, follow the prompt to allow Chrome to install apps. -3. Open the game, log in and download the first-run resources, then shut down the instance in AUTO-MAS. +1. Swipe up from the Android home screen to open the app list. Use Chrome to download the game's Android installer from its official website and install it. If Android prompts you to allow Chrome to install apps, follow the prompt. +2. Open the game, sign in and download the first-run resources. When you are done, shut down the instance in the manager or AUTO-MAS. To go back to the home screen, use the ○ button on the window's side toolbar. Swiping up from the bottom edge of the screen does not take you home. -After that, when a task starts the instance, whether it has a window follows the **静默模式** (Silent mode) setting in AUTO-MAS. For how to work with scripts such as MAA and M9A, follow the AUTO-MAS documentation. +When an AUTO-MAS task starts an instance, its **静默模式** (Silent mode) setting controls whether the emulator window opens. For how to work with scripts such as MAA and M9A, follow the AUTO-MAS documentation. ## Uninstall -First remove this emulator under **管理模拟器** (Manage emulators) in AUTO-MAS, then delete the whole folder. Crash dumps (if any) are in `%TEMP%\AndroidEmulator\emu-crash-37.2.10-mas.db\` and can be deleted along with it. Entries in the same directory without `-mas` in their names belong to the official emulator, not to this project. +Shut down all instances. If you added ModAVD to AUTO-MAS, remove it under **管理模拟器** (Manage emulators). Then delete the ModAVD folder. Crash dumps (if any) are in `%TEMP%\AndroidEmulator\emu-crash-37.2.10-mas.db\` and can be deleted along with it. Entries in the same directory without `-mas` in their names belong to the official emulator, not to this project. diff --git a/docs/en/index.md b/docs/en/index.md index 5909426..1735c9d 100644 --- a/docs/en/index.md +++ b/docs/en/index.md @@ -18,7 +18,7 @@ hero: features: - title: Windowed or headless - details: Run it with a window as an ordinary emulator, or without one. The bundled manager, the CLI or an automation tool such as AUTO-MAS starts it and shuts it down when you are done. + details: Start an instance with a window from the bundled manager. The CLI and automation tools such as AUTO-MAS can also start it headless. - title: Survives a force-kill details: The data disk is handed to Android write-through, so force-killing the emulator does not corrupt the virtual disk's metadata. Crash handling no longer exits at random. - title: Uses fewer resources diff --git a/docs/guide/index.md b/docs/guide/index.md index 2ae09d6..7446e10 100644 --- a/docs/guide/index.md +++ b/docs/guide/index.md @@ -37,7 +37,7 @@ ModAVD是基于 AOSP Android Emulator 37.2.10 的安卓模拟器,加了一批 | 内存 | 每台实例默认 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 说明 | +| AUTO-MAS(可选) | 需要用 AUTO-MAS 管理实例时,查看所用 ModAVD 版本的发布说明,确认兼容的 AUTO-MAS 版本 | ## 免责声明 diff --git a/docs/guide/install.md b/docs/guide/install.md index 9b6d7ff..9c37ef2 100644 --- a/docs/guide/install.md +++ b/docs/guide/install.md @@ -1,12 +1,11 @@ # 安装 -以 AUTO-MAS 为例。整个过程不需要管理员权限,开启 Windows 功能那一步除外。 +用自带的管理器即可安装和使用 ModAVD。需要管理员权限的步骤只有开启 Windows 功能。 ## 开始前确认 - Windows 10 / 11,64 位;CPU 是 Intel 或 AMD 的 x86_64。 - 显卡支持 Vulkan(独立显卡或较新的集成显卡)。 -- AUTO-MAS:推荐 `v5.7.0` 或更新。v5.7.0-beta.5 起支持 MAA 和全部 MFW 脚本,更早的版本见 Release 说明。 - 找一块空间大的 NTFS 盘: - 补全组件时要约 6.5 GB 可用,装完以后组件和模拟器本体共占约 5 GB; - 每台实例第一次开机时,所在的盘要有 10 GB 以上可用; @@ -14,9 +13,9 @@ ## 1. 下载并解压 -从 [Releases](https://github.com/ModAVD/ModAVD/releases) 下载 `ModAVD-<版本>-win-x64.zip`(下面以 `0.36.0` 为例)。 +从[最新发布页](https://github.com/ModAVD/ModAVD/releases/latest)下载 `ModAVD-<版本>-win-x64.zip`。 -压缩包里没有外层文件夹,请右键「全部解压缩」,或用 7-Zip「解压到 ModAVD-0.36.0-win-x64\」,得到 `ModAVD-0.36.0-win-x64` 文件夹。不要用「解压到当前文件夹」,否则文件会直接散在压缩包所在的目录里。 +压缩包里没有外层文件夹。右键「全部解压缩」,或用 7-Zip 解压到一个以压缩包命名的文件夹。不要用「解压到当前文件夹」,否则文件会直接散在压缩包所在的目录里。 把它放到一个**只含英文、数字**的路径,可以改名,例如 `D:\ModAVD`。 @@ -96,31 +95,32 @@ adb 和系统镜像要在你的电脑上从官方渠道下载。两种做法, 开了还是不行,多半是 BIOS 里没开 CPU 虚拟化。进 BIOS 打开 Intel VT-x 或 AMD SVM,具体位置看主板说明书。 -## 4. 在 AUTO-MAS 里添加 +## 4. 新建并启动实例 + +双击解压目录里的 `ModAVD.exe`,点「新建实例」。创建完成后,在实例卡片上点「开机」,就可以打开模拟器窗口。命令行的用法见[管理器和命令行](../components/manager)。 + +### 接入 AUTO-MAS(可选) + +先看所用 ModAVD 版本的发布说明,确认兼容的 AUTO-MAS 版本。 1. 打开「模拟器管理」。 2. 还没有模拟器配置的话,点「手动添加模拟器」,把模拟器类型选成「自动识别(推荐)」;已经有这种配置的直接用它。 3. 在这个配置里点「管理模拟器」→「添加魔改 AVD(内测)」,选第 1 步解压的文件夹,点「检查」。 -4. 电脑检查全部通过后点「添加」。添加完会自动建好第一台实例。 +4. 电脑检查全部通过后点「添加」,就可以在 AUTO-MAS 里管理这个目录下的实例。 「检查」里哪一项没通过,就按提示处理;虚拟化没通过见上一节。 -::: tip 不用 AUTO-MAS 时 -双击包根的 `ModAVD.exe` 打开管理器,可以新建实例、开关机、看画面。命令行 `tools\modavd.exe` 的用法见[管理器和命令行](../components/manager)。 -::: - ## 5. 第一次使用 -每台新实例都要先手动开一次机,装游戏、登录账号: +如果要跑游戏,第一次先在模拟器窗口里安装和登录: -1. 在设备列表里点这台实例的启动按钮。手动启动会显示模拟器窗口。 -2. 在窗口里从下往上滑,打开应用列表,用 Chrome 到游戏官网下载安卓安装包并安装。系统提示不允许安装未知应用时,按提示允许 Chrome 安装应用。 -3. 打开游戏,登录,下完首次资源,然后在 AUTO-MAS 里关闭实例。 +1. 在安卓桌面上从下往上滑打开应用列表,用 Chrome 到游戏官网下载安卓安装包并安装。系统提示不允许安装未知应用时,按提示允许 Chrome 安装应用。 +2. 打开游戏,登录并下载首次资源。用完后,在管理器或 AUTO-MAS 里关机。 回桌面请用窗口侧边工具栏的 ○ 键;从屏幕底边上滑回不了桌面。 -之后由任务拉起时,有没有窗口跟着 AUTO-MAS 的「静默模式」走。具体怎么配合 MAA、M9A 等脚本,以 AUTO-MAS 的说明为准。 +如果用 AUTO-MAS 跑任务,启动时是否显示窗口由它的「静默模式」设置决定。具体怎么配合 MAA、M9A 等脚本,以 AUTO-MAS 的说明为准。 ## 卸载 -先在 AUTO-MAS 的「管理模拟器」里移除这个模拟器,再删掉整个文件夹。崩溃转储(如果有)在 `%TEMP%\AndroidEmulator\emu-crash-37.2.10-mas.db\`,可以一并删掉;同一目录下名字里没有 `-mas` 的是官方模拟器的,不是本项目的。 +先关闭所有实例。如果在 AUTO-MAS 里添加过这个模拟器,先从「管理模拟器」里移除,再删除整个 ModAVD 文件夹。崩溃转储(如果有)在 `%TEMP%\AndroidEmulator\emu-crash-37.2.10-mas.db\`,可以一并删掉;同一目录下名字里没有 `-mas` 的是官方模拟器的,不是本项目的。 diff --git a/docs/index.md b/docs/index.md index da6b5d2..5f79833 100644 --- a/docs/index.md +++ b/docs/index.md @@ -18,7 +18,7 @@ hero: features: - title: 开窗口用,也能无头跑 - details: 可以开窗口当普通模拟器用,也可以不开窗口运行,由自带的管理器、命令行或 AUTO-MAS 这类自动化工具拉起、用完关掉。 + details: 用自带的管理器可以带窗口启动。命令行或 AUTO-MAS 等自动化工具也可以无头启动。 - title: 扛得住强行结束 details: 数据盘以直写方式交给安卓,强行结束模拟器不会弄坏虚拟磁盘的元数据;崩溃处理不再随机退出。 - title: 少占资源