kotones-auto-assistant/README.md

82 lines
2.6 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# Kotone's Auto Assistant 琴音小助手
## 功能
* 自动日常,包括
* 领取礼物(邮件)
* 领取活动费
* 领取工作奖励并自动重新安排工作
* 竞赛挑战
* 领取任务奖励
* 清理商店
* 包括 AP 商店和金币商店
* 可以购买推荐商品,或者指定要购买的物品
* 低配版自动培育
* 支持 REGULAR 和 PRO 模式<sup>1</sup>
* 支持指定 P 偶像<sup>2</sup>
* 支持指定使用增强道具(笔记数量和 Pt 数量提升)
* 暂时**只能使用自动编成**回忆和支援卡
* 对于非练习周,如果没有推荐休息,暂时只会按顺序执行活动支给(活動支給)、文化课(授業)、休息这三种,不支持外出(おでかけ)和咨询(相談)
* 领取技能卡和 P 饮料时,固定领取第一个。若 P 饮料溢出,则不领取
<sup>1 2</sup> 见后文的注意事项
## 安装
### 模拟器要求
* 分辨率:必须是 1280x720
* 系统版本Android 10+QAPI 29这是游戏的要求
* 已开启游戏加速器或代理且网络通畅
### 普通用户
TODO
### 技术用户
琴音小助手通过 pip 分发,因此你可以执行下面的命令来安装:
```bash
pip install ksaa
```
> 琴音小助手的缩写是“kaa”**K**otone's **A**uto **A**ssist
> 但是“kaa”已经被其他包占用了
> 因此改用“ksaa”**K**otone'**s** **A**uto **A**ssist
不过为了避免依赖冲突,你最好使用 pipx 来安装:
```bash
# 安装 pipx
scoop install pipx
pipx ensurepath
# 安装 kaa
pipx install ksaa
```
(也可以通过 pip 安装 pipx详见 [pipx 文档](https://github.com/pypa/pipx#on-windows)
如果你不想使用 pipx也可以手动创建虚拟环境并使用普通的 pip 安装。
安装完成后,只需要运行 `kaa` 命令即可启动 GUI 界面:
```bash
kaa
```
需要注意的是,配置文件 `config.json` 会自动在工作目录下生成。
因此你最好每次都在同一个地方运行 kaa否则可能会出现找不到配置文件的情况。
## 使用
### 配置
TODO
### 注意事项
> [!NOTE]
> 建议使用 **REGULAR 模式**
> 因为 PRO 模式还没有经过充分测试。
> [!IMPORTANT]
> 尽管名字叫“琴音小助手”,但是强烈建议你
> **不要在自动培育中使用琴音**。
>
> 因为琴音的黄色服饰会严重干扰推荐卡的检测,
> 导致打出错误的技能卡。
> [!IMPORTANT]
> 建议**使用亲密度至少为 7 的偶像**进行培育,
> 因为琴音小助手暂时无法处理亲密度提升事件。
## 开发
见[DEVELOPMENT.md](./docs/DEVELOPMENT.md)