mirror of
https://github.com/LmeSzinc/StarRailCopilot.git
synced 2024-11-15 22:19:18 +00:00
Doc: Add installation tutorial in readme
This commit is contained in:
LmeSzinc
parent
f85be40c98
commit
d4bd437330
57
README.md
57
README.md
@ -3,70 +3,27 @@
|
||||
|
||||
# StarRailCopilot
|
||||
|
||||
Star Rail auto script | 星铁副驾驶，崩坏：星穹铁道脚本，基于下一代Alas框架。
|
||||
Star Rail auto script | 星铁速溶茶，崩坏：星穹铁道脚本，基于下一代Alas框架。
|
||||
|
||||
## 安装
|
||||
|
||||
### 获取源码
|
||||
|
||||
SRC 还在开发中，暂时不提供自动安装包，需要以正常流程安装。
|
||||
## 功能
|
||||
|
||||
Clone 这个项目。
|
||||
- **打本**：每日副本，双倍活动副本。
|
||||
- **收获**：尽量完成每日任务，委托，无名勋礼。
|
||||
- **后台托管**：自动启动模拟器和游戏，后台托管清体力和每日。
|
||||
|
||||
```bash
|
||||
git clone https://github.com/LmeSzinc/StarRailCopilot
|
||||
```
|
||||
|
||||
进入项目目录。
|
||||
|
||||
```bash
|
||||
cd StarRailCopilot
|
||||
```
|
||||
## 安装 [](https://github.com/LmeSzinc/StarRailCopilot/releases)
|
||||
|
||||
使用 conda 新建 python 3.10.10 环境，假设新环境的名字叫 `src`。
|
||||
|
||||
> 注意：我们不维护更高或者更低版本的依赖，建议使用 3.10.10
|
||||
|
||||
```bash
|
||||
conda create -n src python==3.10.10
|
||||
```
|
||||
|
||||
激活刚刚创建的虚拟环境。
|
||||
|
||||
```bash
|
||||
conda activate src
|
||||
```
|
||||
|
||||
安装 requirements.txt 中的依赖。
|
||||
|
||||
```bash
|
||||
pip install -r requirements.txt
|
||||
```
|
||||
|
||||
### 安装模拟器
|
||||
|
||||
1. 下载 [ADB](https://developer.android.com/tools/releases/platform-tools) 并配置到环境变量中。
|
||||
1. 在模拟器里安装游戏，而不是桌面端，建议使用最牛批的 MuMu 12，次选蓝叠模拟器。
|
||||
[中文安装教程](https://github.com/LmeSzinc/StarRailCopilot/wiki/Installation_cn)，包含自动安装教程，使用教程，手动安装教程。
|
||||
|
||||
> **为什么使用模拟器？** 如果你用桌面端来运行脚本的话，游戏窗口必须保持在前台，我猜你也不想运行脚本的时候不能动鼠标键盘像个傻宝一样坐在那吧，所以用模拟器。
|
||||
|
||||
> **模拟器的性能表现如何？** Lme 的 8700k+1080ti 使用 MuMu 12 模拟器画质设置非常高是有 40fps 的，如果你的配置稍微新一点的话，特效最高 60fps 不是问题。
|
||||
|
||||
## 使用
|
||||
|
||||
还是在刚才的虚拟环境中，启动 GUI 后端（默认开在 22367 端口）。
|
||||
|
||||
```bash
|
||||
python gui.py
|
||||
```
|
||||
|
||||
在浏览器访问 `127.0.0.1:22367`
|
||||
|
||||
在 `SRC设置` - `模拟器设置` - `模拟器Serial` 中按照帮助文本填写。
|
||||
|
||||
进入 `总览` 界面，点击 `启动` 按钮。（SRC 将自动启动模拟器和游戏，如果它们没在运行的话，模拟器启动目前只支持 MuMu 系和夜神系模拟器）
|
||||
|
||||
保持脚本运行，SRC 将在体力恢复的时候自动登录清体力。建议将 `SRC设置` - `优化设置` - `当任务队列清空后` 设置为 `关闭游戏` 以节省资源。
|
||||
|
||||
## 开发
|
||||
|
||||
|
||||
57
README_en.md
57
README_en.md
@ -2,70 +2,27 @@
|
||||
|
||||
# StarRailCopilot
|
||||
|
||||
Star Rail Copilot, a bot for Honkai: Star Rail, based on the next generation ALAS framework.
|
||||
Star Rail Instant Tea, a bot for Honkai: Star Rail, based on the next generation of ALAS framework.
|
||||
|
||||
# Install
|
||||
|
||||
### Get source code
|
||||
|
||||
SRC is still in development, does not have an auto-installer yet, requires classic python project deployment.
|
||||
## Features
|
||||
|
||||
Clone this repository.
|
||||
- **Dungeons**: Dungeons, dungeons at double event
|
||||
- **Rewards**: Complete daily quests if possible, Assignment, Nameless Hourner.
|
||||
- **AFK Auto Farming**: Automatically launch emulators and games, do dungeons and quests in the background.
|
||||
|
||||
```bash
|
||||
git clone https://github.com/LmeSzinc/StarRailCopilot
|
||||
```
|
||||
|
||||
Enter project directory.
|
||||
|
||||
```bash
|
||||
cd StarRailCopilot
|
||||
```
|
||||
## Install [](https://github.com/LmeSzinc/StarRailCopilot/releases)
|
||||
|
||||
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.
|
||||
Refers to [Installation tutorial](https://github.com/LmeSzinc/StarRailCopilot/wiki/Installation_cn), including easy-installer manual, use manual, manual installation tutorial.
|
||||
|
||||
> **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
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user