diff --git a/docs/develop/index.md b/docs/develop/index.md index f8b9dce..612cae9 100644 --- a/docs/develop/index.md +++ b/docs/develop/index.md @@ -4,11 +4,27 @@ ModAVD 只有一个维护者，回复可能要几天。大一点的改动请先 想知道各部分要什么环境和硬件、用 AI 工具时选什么模型，见[分区一览和通用要求](./overview)。 +issue、PR、评论和提交说明用中文或英文都可以。 + +## 按你会的找入口 + +| 你会的 | 能做什么 | 要什么环境 | 从这里开始 | +|---|---|---|---| +| 不写代码，会玩游戏 | 在自己的电脑上跑游戏，报能不能跑、帧率怎么样 | 一台满足[适用环境](../guide/#适用环境)的 Windows 10 / 11 电脑 | [游戏实测和兼容性报告](./testing)；已经测过哪些游戏见 [README](https://github.com/ModAVD/ModAVD#已实测的游戏) | +| 写文档、翻译 | 改错漏、把只有中文的页面和 README 翻成英文、校对英文 | 浏览器就够；本地预览要 Node.js 24 | [文档和本站](./docs)；[文档类 issue](https://github.com/ModAVD/ModAVD/issues?q=is%3Aissue%20is%3Aopen%20label%3Aarea%3Adocs) | +| Go | 管理器和命令行：建实例、开关机、下载组件、界面（页面是原生 JS / CSS），包括给界面做英文版 | Go 1.26、Windows；只编译和跑单测 4 核、8 GB 内存就够 | [管理器和命令行](./manager)；[管理器的 issue](https://github.com/ModAVD/ModAVD/issues?q=is%3Aissue%20is%3Aopen%20label%3Aarea%3Amanager) | +| Java（Android） | 宿主输入法：电脑上打字直接送进安卓 | JDK、两件 Android SDK 组件（共约 1 GB） | [宿主输入法](./ime)；[输入法的 issue](https://github.com/ModAVD/ModAVD/issues?q=is%3Aissue%20is%3Aopen%20label%3Aarea%3Ahostime) | +| PowerShell、Python | 发版前回归（端到端测试）、随包脚本、CI 检查 | PowerShell 7、Python 3.12 | [随包脚本](./package)、[ModAVDE2E](https://github.com/ModAVD/ModAVDE2E)；[回归的 issue](https://github.com/ModAVD/ModAVD/issues?q=is%3Aissue%20is%3Aopen%20label%3Aarea%3Ae2e) | +| C / C++（QEMU、图形、Vulkan、ARM 转译） | 模拟器本体的补丁、arm64 执行桥 | 自己编模拟器要约 140 GB 硬盘，16 核编一次约 1.5 小时；只交补丁的话不要求会编 | [模拟器本体](./emulator)、[arm64 执行桥](./bridge) | +| macOS、Linux | 把 ModAVD 移到别的平台：管理器的平台层、打包、签名 | 对应平台的电脑 | [#27 多平台总体安排](https://github.com/ModAVD/ModAVD/issues/27)；[macOS](https://github.com/ModAVD/ModAVD/issues?q=is%3Aissue%20is%3Aopen%20label%3Aplatform%3Amacos)、[Linux](https://github.com/ModAVD/ModAVD/issues?q=is%3Aissue%20is%3Aopen%20label%3Aplatform%3Alinux) 的 issue | + +第一次来，先看标了 [good first issue](https://github.com/ModAVD/ModAVD/issues?q=is%3Aissue%20is%3Aopen%20label%3A%22good%20first%20issue%22) 的：范围小，不用编模拟器，正文里有英文说明。 + ## 最需要的：在你的电脑上试 维护者只在一台 Windows 11、AMD CPU、NVIDIA 独显的电脑上测过。最缺这些配置的实测：Intel CPU，AMD 或 Intel 显卡，笔记本双显卡，Windows 10，16 GB 内存。 -1. 照[安装](../guide/install)装好，在 AUTO-MAS 里添加，开机后跑一轮日常任务。 +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」。 这份输出不带用户名、电脑名、完整路径和游戏账号，可以直接公开贴。详见[游戏实测和兼容性报告](./testing)。 diff --git a/docs/develop/overview.md b/docs/develop/overview.md index ab4ceb7..cf63ab5 100644 --- a/docs/develop/overview.md +++ b/docs/develop/overview.md @@ -49,8 +49,7 @@ ModAVD 是 AOSP Android Emulator 加一批补丁，WHPX 加速，gfxstream 渲 动手前先看，免得撞车： -- AUTO-MAS 计划改用 `modavd` 命令行管实例、更新整包（改动提到 AUTO-MAS 仓库）； -- ModAVDManager：v0.1.0 已发布，v0.2.0（新建时在后台做完初始化、`modavd update`）待发布，main 上在做 0.3.0（组件与问题反馈、平台层）； -- ModAVDHostIME：v1.0.0 已发布。 +- [已经指派给人](https://github.com/ModAVD/ModAVD/issues?q=is%3Aissue%20is%3Aopen%20assignee%3A*)的 issue，就是有人在做； +- 各仓库开着的 PR，包括草稿。 想做的事和这些有交集，先在 ModAVD 仓库开 issue 说一声（各组件的 issue 都在那里）。 diff --git a/docs/en/develop/index.md b/docs/en/develop/index.md index b5fd5ee..a22a416 100644 --- a/docs/en/develop/index.md +++ b/docs/en/develop/index.md @@ -4,11 +4,27 @@ ModAVD has only one maintainer, so replies can take a few days. For bigger chang To see what environment and hardware each area needs, and which models to pick when you use AI tools, see [Areas and common requirements](./overview). +Issues, PRs, comments and commit messages can be in English or Chinese. + +## Where to start, by what you know + +| What you know | What you can do | What you need | Start here | +|---|---|---|---| +| No coding, you play games | Run games on your own computer and report whether they run and how the frame rate is | A Windows 10 / 11 computer that meets the [requirements](../guide/#requirements) | [Testing on real games and compatibility reports](./testing); for the games already tested, see the [README](https://github.com/ModAVD/ModAVD/blob/main/README.en.md#tested-games) | +| Writing, translating | Fix mistakes, translate pages and READMEs that exist only in Chinese, proofread the English | A browser is enough; previewing locally needs Node.js 24 | [Documentation and this site](./docs); [docs issues](https://github.com/ModAVD/ModAVD/issues?q=is%3Aissue%20is%3Aopen%20label%3Aarea%3Adocs) | +| Go | The manager and CLI: creating instances, starting and stopping, fetching components, the interface (plain JS / CSS pages), including an English version of the interface | Go 1.26 and Windows; building and unit tests need only 4 cores and 8 GB of RAM | [The manager and CLI](./manager); [manager issues](https://github.com/ModAVD/ModAVD/issues?q=is%3Aissue%20is%3Aopen%20label%3Aarea%3Amanager) | +| Java (Android) | The host IME: text typed on the computer goes straight into Android | A JDK and two Android SDK components (about 1 GB in all) | [The host IME](./ime); [IME issues](https://github.com/ModAVD/ModAVD/issues?q=is%3Aissue%20is%3Aopen%20label%3Aarea%3Ahostime) | +| PowerShell, Python | The pre-release regression (end-to-end tests), bundled scripts, CI checks | PowerShell 7, Python 3.12 | [Bundled scripts](./package), [ModAVDE2E](https://github.com/ModAVD/ModAVDE2E); [regression issues](https://github.com/ModAVD/ModAVD/issues?q=is%3Aissue%20is%3Aopen%20label%3Aarea%3Ae2e) | +| C / C++ (QEMU, graphics, Vulkan, ARM translation) | Patches to the emulator itself, the arm64 execution bridge | Building the emulator yourself needs about 140 GB of disk, and one build takes about 1.5 hours on 16 cores; you do not have to build it to send a patch | [The emulator itself](./emulator), [the arm64 execution bridge](./bridge) | +| macOS, Linux | Bring ModAVD to other platforms: the manager's platform layer, packaging, signing | A computer on that platform | [#27 Multi-platform plan](https://github.com/ModAVD/ModAVD/issues/27); [macOS](https://github.com/ModAVD/ModAVD/issues?q=is%3Aissue%20is%3Aopen%20label%3Aplatform%3Amacos) and [Linux](https://github.com/ModAVD/ModAVD/issues?q=is%3Aissue%20is%3Aopen%20label%3Aplatform%3Alinux) issues | + +If this is your first time, look at the issues labeled [good first issue](https://github.com/ModAVD/ModAVD/issues?q=is%3Aissue%20is%3Aopen%20label%3A%22good%20first%20issue%22): they are small, need no emulator build, and have an English summary in the description. + ## What is needed most: try it on your computer 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. +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. 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). diff --git a/docs/en/develop/overview.md b/docs/en/develop/overview.md index d4dd4a9..e01de02 100644 --- a/docs/en/develop/overview.md +++ b/docs/en/develop/overview.md @@ -49,8 +49,7 @@ Verification in several areas needs a running instance. The numbers come from Mo Look here before you start, to avoid collisions: -- AUTO-MAS plans to switch to the `modavd` CLI for managing instances and updating the package (the changes go to the AUTO-MAS repository); -- ModAVDManager: v0.1.0 is released; v0.2.0 (finishes initialization in the background when creating an instance, `modavd update`) is not released yet; 0.3.0 (components and problem reporting, platform layer) is being worked on in main; -- ModAVDHostIME: v1.0.0 is released. +- Issues that are [assigned to someone](https://github.com/ModAVD/ModAVD/issues?q=is%3Aissue%20is%3Aopen%20assignee%3A*) are being worked on; +- open PRs in each repository, including drafts. If what you want to do overlaps with these, say so first in an issue in the ModAVD repository (issues for every component are there). diff --git a/docs/en/index.md b/docs/en/index.md index 83f0afd..5909426 100644 --- a/docs/en/index.md +++ b/docs/en/index.md @@ -26,7 +26,9 @@ features: - title: No data sent to Google details: The emulator does not upload usage statistics or crash reports to Google, does not check Google for updates, and does not download feature flags from Google. Android and its apps use the network as usual. - title: arm64-only games run too - details: The bundled arm64 execution bridge lets games that only have an arm64 build and use app hardening (the Onmyoji channel builds) run on an x86_64 system image. + details: The bundled arm64 execution bridge lets some games that only have an arm64 build run on an x86_64 system image. + link: https://github.com/ModAVD/ModAVD/blob/main/README.en.md#tested-games + linkText: Tested games - title: All patches are public details: The changes to QEMU, gfxstream and Crashpad are published as patches, and every release comes with the full matching source. --- diff --git a/docs/index.md b/docs/index.md index 701f7a8..dc6c59d 100644 --- a/docs/index.md +++ b/docs/index.md @@ -26,7 +26,9 @@ features: - title: 不向 Google 上传数据 details: 模拟器不向 Google 上传使用统计和崩溃报告，不向 Google 检查更新，也不从 Google 下载特性开关。安卓和应用照常联网。 - title: arm64 游戏也能跑 - details: 随包的 arm64 执行桥让只有 arm64 版本、带加固的游戏（《阴阳师》各渠道包）在 x86_64 镜像上跑起来。 + details: 随包的 arm64 执行桥让一部分只有 arm64 版本的游戏在 x86_64 镜像上跑起来。 + link: https://github.com/ModAVD/ModAVD#已实测的游戏 + linkText: 已实测的游戏 - title: 补丁全部公开 details: QEMU、gfxstream、Crashpad 的改动以补丁形式公开，每个 Release 附完整的对应源码。 ---