Doc: Add English README

2024-11-15 22:19:18 +00:00 · 2023-06-20 23:59:29 +08:00 · 2023-06-20 23:59:29 +08:00 · ffe0a6fb9b
commit ffe0a6fb9b
parent 25cd87038d
2 changed files with 113 additions and 8 deletions
--- a/README.md
+++ b/README.md
@ -1,11 +1,14 @@
+**| [English](README_en.md) | 简体中文 |**
+
+
 # StarRailCopilot

 Star Rail auto script | 星铁副驾驶，崩坏：星穹铁道脚本，基于下一代Alas框架。

-QQ群 SRC使用与开发 752620927
-
 ## 安装

+### 获取源码
+
 SRC 还在开发中，暂时不提供自动安装包，需要以正常流程安装。

 Clone 这个项目。
@ -40,15 +43,18 @@ conda activate src
 pip install -r requirements.txt
 ```

-在模拟器里安装游戏，而不是桌面端，建议使用最牛批的 MuMu 12，次选蓝叠模拟器。
+### 安装模拟器

-> **为什么使用模拟器？**如果你用桌面端来运行脚本的话，游戏窗口必须保持在前台，我猜你也不想运行脚本的时候不能动鼠标键盘像个傻宝一样坐在那吧，所以用模拟器。
+1. 下载 [ADB](https://developer.android.com/tools/releases/platform-tools) 并配置到环境变量中。
+1. 在模拟器里安装游戏，而不是桌面端，建议使用最牛批的 MuMu 12，次选蓝叠模拟器。
+
+> **为什么使用模拟器？** 如果你用桌面端来运行脚本的话，游戏窗口必须保持在前台，我猜你也不想运行脚本的时候不能动鼠标键盘像个傻宝一样坐在那吧，所以用模拟器。

 > **模拟器的性能表现如何？** Lme 的 8700k+1080ti 使用 MuMu 12 模拟器画质设置非常高是有 40fps 的，如果你的配置稍微新一点的话，特效最高 60fps 不是问题。

 ## 使用

-还是在刚才的虚拟环境中，启动 GUI 后端，默认开在 22367 端口。
+还是在刚才的虚拟环境中，启动 GUI 后端（默认开在 22367 端口）。

 ```bash
 python gui.py
@ -58,15 +64,25 @@ python gui.py

 在 `SRC设置` - `模拟器设置` - `模拟器Serial` 中按照帮助文本填写。

-进入 `总览` 界面，点击 `启动` 按钮。
+进入 `总览` 界面，点击 `启动` 按钮。（SRC 将自动启动模拟器和游戏，如果它们没在运行的话，模拟器启动目前只支持 MuMu 系和夜神系模拟器）

-（如果模拟器或者游戏不在运行的话，SRC 将自动启动它们，模拟器启动目前只支持 MuMu 系和夜神系模拟器）
+保持脚本运行，SRC 将在体力恢复的时候自动登录清体力。建议将 `SRC设置` - `优化设置` - `当任务队列清空后` 设置为 `关闭游戏` 以节省资源。
+
+## 开发
+
+Discord https://discord.gg/aJkt3mKDEr QQ群 752620927
+
+- 开发文档（目录在侧边栏）：[Alas wiki](https://github.com/LmeSzinc/AzurLaneAutoScript/wiki/1.-Start)，但很多内容是新写的，建议阅读源码和历史提交。
+
+- 开发路线图：[#10](https://github.com/LmeSzinc/StarRailCopilot/issues/10) ，欢迎提交 PR，挑选你感兴趣的部分进行开发即可。
+
+> **如何添加多语言/多服务器支持？** 需要适配 assets，参考 [开发文档 “添加一个 Button” 一节](https://github.com/LmeSzinc/AzurLaneAutoScript/wiki/4.1.-Detection-objects#%E6%B7%BB%E5%8A%A0%E4%B8%80%E4%B8%AA-button)。



 ## 关于 Alas

-SRC 将基于碧蓝航线脚本 [AzurLaneAutoScript](https://github.com/LmeSzinc/AzurLaneAutoScript) 开发，Alas 经过三年的发展现在已经达到一个高完成度，但也累积了不少屎山难以改动，我们希望在新项目上解决这些问题：
+SRC 基于碧蓝航线脚本 [AzurLaneAutoScript](https://github.com/LmeSzinc/AzurLaneAutoScript) 开发，Alas 经过三年的发展现在已经达到一个高完成度，但也累积了不少屎山难以改动，我们希望在新项目上解决这些问题。

 - 更新 OCR 库。Alas 在 cnocr==1.2.2 上训练了多个模型，但依赖的 [mxnet](https://github.com/apache/mxnet) 已经不怎么活跃了，机器学习发展迅速，新模型的速度和正确率都碾压旧模型。
 - 配置文件 [pydantic](https://github.com/pydantic/pydantic) 化。自任务和调度器的概念加入后用户设置数量倍增，Alas 土制了一个代码生成器来完成配置文件的更新和访问，pydantic 将让这部分更加简洁。
--- a/README_en.md
+++ b/README_en.md
@ -0,0 +1,89 @@
+**| English | [简体中文](README.md) |**
+
+# StarRailCopilot
+
+Star Rail Copilot, a bot for Honkai: Star Rail, based on the next generation ALAS framework.
+
+# Install
+
+### Get source code
+
+SRC is still in development, does not have an auto-installer yet, requires classic python project deployment.
+
+Clone this repository.
+
+```bash
+git clone https://github.com/LmeSzinc/StarRailCopilot
+```
+
+Enter project directory.
+
+```bash
+cd StarRailCopilot
+```
+
+Create a python 3.10.10 environment using conda. Let's say the new environment is named `src`.
+
+>Note that we don't maintain requirements for lower or higher python versions, 3.10.10 is recommended.
+
+```bash
+conda create -n src python==3.10.10
+```
+
+Activate the environment just created.
+
+```bash
+conda activate src
+```
+
+Install requirements.
+
+```
+pip install -r requirements.txt
+```
+
+### Install an Emulator
+
+1. Download [ADB](https://developer.android.com/tools/releases/platform-tools) and configure it into environment variables.
+2. Install the game client in emulator, not the desktop client. BlueStacks is recommented.
+
+> **Why use emulators?** If you run a bot on the desktop client, game windows must stay at front. I guess you don't wanna baby-sit there without being able to move the mouse and keyboard while running the bot, so use the emulators.
+
+> **How's the performance?** Lme's 8700k+1080ti using MuMu12 emulator with graphic settings very high  gets 40 fps. It shouldn't be a problem to run with maximum graphic settings and 60 fps if you have newer PC specs.
+
+## Usage
+
+Still in the environment just now, launch the GUI backend. (running on port 22367 by default)
+
+```bash
+python gui.py
+```
+
+Access `127.0.0.1:22367` in browser.
+
+Goto `SRC settings` - `Emulator Settings` - `Serial`, fill it according to help texts.
+
+Goto `Overview` page, click `Run` button. (SRC will auto launch emulator and game client if they are not running. Emulator launch only supports MuMu family and Nox Player family for now)
+
+Keep the bot running, SRC will auto login and empty trailblaze power when it's recovered. To save resources, set `SRC Settings` - `Optimazation Settings` - `When Task Queue is Empty` to `Close Game`.
+
+## Development
+
+Discord https://discord.gg/aJkt3mKDEr QQ Group 752620927
+
+- Development Docs (menu is on sidebar): [Alas wiki](https://github.com/LmeSzinc/AzurLaneAutoScript/wiki/1.-Start) (in Chinese). However, there is ton of code newly written, it is recommended to read the source code and historical commits.
+
+- Development Road Map: [#10](https://github.com/LmeSzinc/StarRailCopilot/issues/10). Pull Requests are welcomed, just pick the part you interested to work on.
+
+> **How to add multi-language or multi-server support?** Need assets updates, see ["Adding a Button" in development docs](https://github.com/LmeSzinc/AzurLaneAutoScript/wiki/4.1.-Detection-objects#%E6%B7%BB%E5%8A%A0%E4%B8%80%E4%B8%AA-button).
+
+
+
+## About ALAS
+
+SRC is based on an Azur Lane bot [AzurLaneAutoScript](https://github.com/LmeSzinc/AzurLaneAutoScript). After 3 years of development, ALAS has reached a high degree of completion, but it has also accumulated a lot of shit code that is difficult to change. We hope that Fix these issues on a new project.
+
+- Update OCR. ALAS has trained multiple models on cnocr==1.2.2, but the dependent [mxnet](https://github.com/apache/mxnet) is no longer active, machine learning is developing rapidly, and the speed of new models and the correct rate crushes the old model.
+- Converting setting files into [pydantic](https://github.com/pydantic/pydantic) models. Since the concept of task and scheduler was added, the number of user settings greatly increased. ALAS has built a code generator to implement setting read and update. pydantic will make things more elegantly.
+- Better Assets management. button_extract helps ALAS to easily maintain 4000+ template images, but it has a serious performance issue, and the reminder of multi-server supported is also submerged in a large amount of meaningless logs.
+- Reduced coupling to Azur Lane. The ALAS framework and ALAS GUI have the ability to interface with other games and their not, but the completed [MAA](https://github.com/MaaAssistantArknights/MaaAssistantArknights) plug-in for Arknights and [fgo-py](https: //github.com/hgjazhgj/FGO-py) plug-in under development have found serious coupling problems between ALAS and the Azur Lane game itself.