Doc: README.md for new GUI

This commit is contained in:
LmeSzinc 2021-10-27 23:15:00 +08:00
parent 3cd9078fd8
commit d27641341e
5 changed files with 112 additions and 352 deletions

137
README.md
View File

@ -1,33 +1,21 @@
[Check Wiki for installation guide](https://github.com/LmeSzinc/AzurLaneAutoScript/wiki)
**| [English](README_en.md) | Chinese |**
# AzurLaneAutoScript
![GitHub LmeSzinc Releases](https://img.shields.io/github/downloads/LmeSzinc/AzurLaneAutoScript/total)
#### Discord
[![](https://img.shields.io/discord/720789890354249748?logo=discord)](https://discord.gg/AQN6GeJ)
#### Discord [![](https://img.shields.io/discord/720789890354249748?logo=discord&logoColor=ffffff&color=4e4c97)](https://discord.gg/AQN6GeJ) QQ群 ![](https://img.shields.io/badge/QQ%20Group-1087735381-4e4c97)
Alas, an Azur Lane automation tool with GUI (Supports CN, EN, JP, TW, able to support other servers), designed for 24/7 running scenes, can take over almost all Azur Lane gameplay. Azur Lane, as a mobile game, has entered the late stage of its life cycle. During the period from now to the server down, please reduce the time spent on the Azur Lane and leave everything to Alas.
### QQ群 1087735381
Alas一个带GUI的碧蓝航线脚本支持国服, 国际服, 日服, 台服, 可以支持其他服务器),为 7x24 运行的场景而设计,能接管近乎全部的碧蓝航线玩法。碧蓝航线,作为一个手游,已经进入了生命周期的晚期。从现在到关服的这段时间里,请减少花费在碧蓝航线上的时间,把一切都交给 Alas。
Alas, an Azur Lane automation tool with GUI (Support CN, EN, JP, TW, able to support other servers).
EN support, thanks **[@whoamikyo](https://github.com/whoamikyo)** and **[@nEEtdo0d](https://github.com/nEEtdo0d)**.
Alas, 一个带GUI的碧蓝航线脚本 (支持国服, 国际服, 日服, 台服, 可以支持其他服务器).
JP support, thanks **[@ferina8-14](https://github.com/ferina8-14)**, **[@noname94](https://github.com/noname94)** and **[@railzy](https://github.com/railzy)**.
EN support, Thanks **[@whoamikyo](https://github.com/whoamikyo)** and **[@nEEtdo0d](https://github.com/nEEtdo0d)**.
TW support, thanks **[@Zorachristine](https://github.com/Zorachristine)** , some features might not work.
JP support, Thanks **[@ferina8-14](https://github.com/ferina8-14)**, **[@noname94](https://github.com/noname94)** and **[@railzy](https://github.com/railzy)** , some features might not work.
GUI development, thanks **[@18870](https://github.com/18870)** , say HURRAY.
TW support, Thanks **[@Zorachristine](https://github.com/Zorachristine)** , some features might not work.
> **Event Announcement 活动公告**
>
> [CN] 支持活动「碧海光粼」.
>
> [EN] Support event "Upon the Shimmering Blue".
>
> [JP] Support event 「駆けよ 碧海の吹き風」.
![](https://img.shields.io/github/commit-activity/m/LmeSzinc/AzurLaneAutoScript?color=4e4c97) ![](https://img.shields.io/tokei/lines/github/LmeSzinc/AzurLaneAutoScript?color=4e4c97) ![](https://img.shields.io/github/repo-size/LmeSzinc/AzurLaneAutoScript?color=4e4c97) ![](https://img.shields.io/github/issues-closed/LmeSzinc/AzurLaneAutoScript?color=4e4c97) ![](https://img.shields.io/github/issues-pr-closed/LmeSzinc/AzurLaneAutoScript?color=4e4c97)
![gui](doc/README.assets/gui.png)
@ -35,90 +23,53 @@ TW support, Thanks **[@Zorachristine](https://github.com/Zorachristine)** , some
## 功能 Features
- **主线图出击** 针对复杂地图优化, 降低BOSS队被堵住而多打一战的可能性, 能处理伏击空袭
- **出击**主线图活动图共斗活动1-1 伏击刷好感7-2 三战捡垃圾12-2 中型练级12-4 大型练级,紧急委托刷钻石。
- **收获**:委托,战术学院,科研,后宅,指挥喵,大舰队,收获,商店购买,开发船坞,每日抽卡,档案密钥。
- **每日**每日任务困难图演习潜艇图活动每日AB图活动每日SP图共斗活动每日作战档案。
- **大世界**:余烬信标,每月开荒,大世界每日,隐秘海域,短猫相接。
- **活动图出击** 支持在非周回模式下运行, 能处理移动距离限制, 光之壁, 传送门, 岸防炮, 地图解谜, 地图迷宫
#### 突出特性:
- **每日任务** 半小时左右一套做完, 重复运行时会跳过当天做过的
每日任务, 困难图, 演习(自动SL), 活动每日AB图+SP图, 共斗活动每天15把
- **委托收派** 出击时自动切出去收获, 支持收派委托, 收派科研, 收派战术学院, 收任务
大舰队作战派遣, 提交物资, 打大舰队BOSS
- **特定模式出击** 7-2三战拣垃圾, 12图练级. 1-1刷好感, 打潜艇图, 低级图刷委托并更换低级白皮轻航为旗舰.
- **大世界全自动** 一条龙完成: 接大世界每日, 买空港口商店, 做大世界每日, 短猫相接直到完成两次余烬信标.
清理隐秘海域每30分钟触发以保证空域搜索冷却. 明石商店购买.
每月重置后清理所有危险海域.
- **其他小功能**
心情控制, 计算心情防止红脸或者保持经验加成状态
血量监控, 低血量撤退, 先锋血量平衡(自动更换承伤位和保护位)
商店扫货, 在通用商店, 军需商店, 舰队商店, 勋章兑换中购买特定物品
每天买猫, 猫窝摸猫
掉落截图记录, 掉率统计, 科研统计
- **心情控制**:计算心情防止红脸或者保持经验加成状态。
- **活动图开荒**:支持在非周回模式下运行,能处理移动距离限制,光之壁,传送门,岸防炮,地图解谜,地图迷宫等特殊机制。
- **无缝收菜**:时间管理大师,计算委托科研等的完成时间,完成后立即收获。
- **大世界**一条龙完成接大世界每日买空港口商店做大世界每日短猫相接购买明石商店每30分钟清理隐秘海域。
- **大世界月初开荒**大世界每月重置后不需要购买作战记录仪5000油道具即可开荒。
## 安装 Installation
## 安装 Installation [![](https://img.shields.io/github/downloads/LmeSzinc/AzurLaneAutoScript/total?color=4e4c97)](https://github.com/LmeSzinc/AzurLaneAutoScript/releases)
详见 [中文安装教程](https://github.com/LmeSzinc/AzurLaneAutoScript/wiki/Installation_cn_manual)
详见 [中文安装教程](https://github.com/LmeSzinc/AzurLaneAutoScript/wiki/Installation_cn),包含自动安装教程,使用教程,手动安装教程,远程控制教程。
## 使用注意事项 Note
## 如何上报bug How to Report Bugs
- 模拟器分辨率需要为 1280 x 720.
- 需要关闭`开发者选项-输入-指针位置(屏幕叠加层显示当前触摸数据)`, 因为这会遮挡模拟器内的游戏画面.
- 当修改完设置后, 需要点击 `开始` 来保存选项, 然后点击 `编辑` 返回主界面. 因为位于左侧的每一项功能都是分别保存和运行的.
- 当你的图打到一半的时候, 需要手动打完或者手动撤退, 再启动 Alas.
在提问题之前至少花费 5 分钟来思考和准备,才会有人花费他的 5 分钟来帮助你。"XX怎么运行不了""XX卡住了",这样的描述将不会得到回复。
- 在提问题前,请先阅读 [常见问题(FAQ)](https://github.com/LmeSzinc/AzurLaneAutoScript/wiki/FAQ_en_cn)。
- 检查 Alas 的更新和最近的 commit确认使用的是最新版。
- 上传出错 log`log/error` 目录下,以毫秒时间戳为文件夹名,包含 log.txt 和最近的截图。若不是错误而是非预期的行为,提供在 `log` 目录下当天的 log和至少一张游戏截图。
## 如何上报bug How to report
## 已知问题 Known Issues
- 在提问题前, 请先阅读 [常见问题(FAQ)](https://github.com/LmeSzinc/AzurLaneAutoScript/wiki/FAQ_en_cn)
- 检查 Alas 的更新和最近的 commit. 确认使用的是最新版.
- 上传出错log. 在 `log/error` 目录下, 以毫秒时间戳为文件夹名, 包含 log.txt 和最近60张截图.
- **无法处理网络波动**,重连弹窗,跳小黄鸡。
- **在极低配电脑上运行可能会出现各种问题**极低配指截图耗时大于1s一般电脑耗时约0.5s高配耗时约0.3s。
- **演习可能SL失败**演习看的是屏幕上方的血槽血槽可能被立绘遮挡因此需要一定时间默认1s血量低于一定值默认40%才会触发SL。一个血皮后排就有30%左右的血槽,所以有可能在 1s 内被打死。
- **逍遥模拟器不支持 minitouch 长按,无法进行后宅喂食**,建议不用逍遥模拟器。
- **极少数情况下 ADB 和 uiautomator2 会抽风**,是模拟器的问题,重启模拟器即可。
- **拖动操作在模拟器卡顿时,会被视为点击**
## 已知问题 Known issue
按出现频率排列
- **GUI启动慢, uiautomator2启动慢**
- **无法处理网络波动** 重连弹窗, 跳小黄鸡
- **在极低配电脑上运行可能会出现各种问题** 缓慢修复中
极低配, 指截图耗时大于1s. 一般电脑耗时约0.5s, 高配耗时约0.3s, 高配+aScreenCap截图耗时小于0.15s.
- **会显示绿脸黄脸红脸** 这个是瓜游心情值更新BUG, Alas会每隔2小时重启游戏来更新心情.
- **演习可能SL失败** 演习看的是屏幕上方的血槽, 血槽可能被立绘遮挡, 因此需要一定时间(默认1s)血量低于一定值(默认40%)才会触发SL. 一个血皮后排就有30%左右的血槽, 所以别以为在1s内被打掉40%是不可能的. 另外如果后排立绘过大且CD重叠严重, 建议增大确认时间(比如3s), 或者换皮肤, 这样可以减少误判.
- **极少数情况下ADB和uiautomator2会抽风**
- **拖动操作在极少数情况下无效**
## 文档 Doc
## 文档 Documents
[海图识别 perspective](https://github.com/LmeSzinc/AzurLaneAutoScript/wiki/perspective)
`海图识别` 是一个碧蓝航线脚本的核心. 如果只是单纯地使用 `模板匹配 (Template matching)` 来进行索敌, 就不可避免地会出现 BOSS被小怪堵住 的情况. `AzurLaneAutoScript` 提供了一个更好的海图识别方法, 在 `module.map` 中, 你将可以得到完整的海域信息, 比如:
`海图识别` 是一个碧蓝航线脚本的核心,如果只是单纯地使用 `模板匹配 (Template matching)` 来进行索敌,就不可避免地会出现 BOSS被小怪堵住 的情况。 Alas 提供了一个更好的海图识别方法,在 `module.map_detection` 中,你将可以得到完整的海域信息,比如:
```
2020-03-10 22:09:03.830 | INFO | A B C D E F G H
@ -129,19 +80,15 @@ TW support, Thanks **[@Zorachristine](https://github.com/Zorachristine)** , some
2020-03-10 22:09:03.830 | INFO | 5 -- -- -- 2E -- 2E ++ ++
```
[参与开发 development](https://github.com/LmeSzinc/AzurLaneAutoScript/wiki/development)
- 如何添加一个按钮 How to add a button
- 如何适配一张新的地图 How to adapt to a new map
- 如何支持其他服务器/语言 How to support other server/language
更多文档, 请前往 [WIKI](https://github.com/LmeSzinc/AzurLaneAutoScript/wiki).
开发文档,请前往 [WIKI](https://github.com/LmeSzinc/AzurLaneAutoScript/wiki)。
## 参考 Reference
## 相关项目 Relative Repositories
- [code:azure](https://asaiq.lofter.com/), 浅. (Not open source) 现成的碧蓝航线脚本, 完成度很高. 参考了主要的功能和设置.
- [ALAuto](https://github.com/Egoistically/ALAuto), Egoistically. EN服的碧蓝航线脚本, 模仿了脚本架构.
- [ALAuto homg_trans_beta](https://github.com/asd111333/ALAuto/tree/homg_trans_beta), asd111333. 引入了单应性变换至海图识别模块中.
- [AzurStats](https://azur-stats.lyoko.io/),基于 Alas 实现的碧蓝航线掉落统计平台。
- [AzurLaneUncensored](https://github.com/LmeSzinc/AzurLaneUncensored),与 Alas 对接的碧蓝航线反和谐。
- [ALAuto](https://github.com/Egoistically/ALAuto)EN服的碧蓝航线脚本已不再维护Alas 模仿了其架构。
- [ALAuto homg_trans_beta](https://github.com/asd111333/ALAuto/tree/homg_trans_beta)Alas 引入了其中的单应性变换至海图识别模块中。
- [PyWebIO](https://github.com/pywebio/PyWebIO)Alas 使用的 GUI 库。

View File

@ -1,52 +1,92 @@
[English Quick Guide](doc%2FQuick_guide.md)
[Download Easy Install-v2](https://github.com/whoamikyo/AzurLaneAutoScript/releases)
**| English | [Chinese](README.md) |**
# AzurLaneAutoScript
Alas, an Azur Lane automation tool with GUI (For CN server, can support other server).
#### Discord [![](https://img.shields.io/discord/720789890354249748?logo=discord&logoColor=ffffff&color=4e4c97)](https://discord.gg/AQN6GeJ) QQ Group ![](https://img.shields.io/badge/QQ%20Group-1087735381-4e4c97)
Alas, an Azur Lane automation tool with GUI (Supports CN, EN, JP, TW, able to support other servers), designed for 24/7 running scenes, can take over almost all Azur Lane gameplay. Azur Lane, as a mobile game, has entered the late stage of its life cycle. During the period from now to the server down, please reduce the time spent on the Azur Lane and leave everything to Alas.
EN support, thanks **[@whoamikyo](https://github.com/whoamikyo)** and **[@nEEtdo0d](https://github.com/nEEtdo0d)**.
JP support, thanks **[@ferina8-14](https://github.com/ferina8-14)**, **[@noname94](https://github.com/noname94)** and **[@railzy](https://github.com/railzy)**.
TW support, thanks **[@Zorachristine](https://github.com/Zorachristine)** , some features might not work.
GUI development, thanks **[@18870](https://github.com/18870)** , say HURRAY.
![](https://img.shields.io/github/commit-activity/m/LmeSzinc/AzurLaneAutoScript?color=4e4c97) ![](https://img.shields.io/tokei/lines/github/LmeSzinc/AzurLaneAutoScript?color=4e4c97) ![](https://img.shields.io/github/repo-size/LmeSzinc/AzurLaneAutoScript?color=4e4c97) ![](https://img.shields.io/github/issues-closed/LmeSzinc/AzurLaneAutoScript?color=4e4c97) ![](https://img.shields.io/github/issues-pr-closed/LmeSzinc/AzurLaneAutoScript?color=4e4c97)
![gui](doc/README.assets/gui_en.png)
## Features
- **Campaign**: Support for new maps grows every day, check a `./campaign` folder to see supported maps
- **Farm**: Main chapter, events, raids, 1-1 affinity farming, 7-2 mystery farming, 12-2 medium leveling, 12-4 large leveling, gems farming.
- **Reward**: Commission, tactical class, research, dorm, meowfficer, guild, missions, shop, shipyard, gacha, data key.
- **Daily**: Daily mission, hard, exercise, SOS, event daily AB, event daily SP, raid daily, war archives.
- **Opsi**: Ash beacon assist, Opsi monthly explore, Opsi daily, obscured zones, meowfficer farming.
- **Events**: Support for new maps grows every day, check a `./campaign` folder to see supported maps
#### Highlighted Features
- **Daily Mission**: Able to finish everything in 30 minutes, repeated run will skip over what has been done on that day
- **Mood Control**: Calculates mood consumption, keep exp bonus or prevent red faces.
- **Event Exploring**: Able to run without clear mode, also handles fleet moving limits and other event mechanism.
- **Seamless Reward**: Calculates the finish time of research, commission, etc. Receive reward and dispatch again when time reached.
- **Operation Siren**: Receive Opsi dailies, purchase port shops, do Opsi dailies, do meowfficer farming, purchase Akashi's shop, clear obscured zones every 30 min.
- **Opsi Explore**: After Opsi monthly reset, re-explore all zones without special radar (5000 oil item)
Daily Mission(Submarine not support).
- **Events x3 Bonus**: 30 minutes to finish A1 to B3 in events.
- **Commissions**: Checks commissions at the configured time during campaign, accept commission rewards, research rewards, and daily mission rewards.
- **Misc Features**
## Installation [![](https://img.shields.io/github/downloads/LmeSzinc/AzurLaneAutoScript/total?color=4e4c97)](https://github.com/LmeSzinc/AzurLaneAutoScript/releases)
Morale Control, Calculate Morale to prevent it from going sad, or to maintain Morale to earn experience.
Refers to [Installation tutorial](https://github.com/LmeSzinc/AzurLaneAutoScript/wiki/Installation_en), including easy-installer manual, use manual, manual installation tutorial, remote access manul.
HP Monitoring, Low HP Retire, Frontline HP Balancing
Equipment Change
Periodic Screeshot Record
Auto Retire
Enhance shipfu
Map completion mode, when running new map, it will try to do 3 star clear
## How to Report Bugs
Spend at least 5 minutes for thinking and preparing, before someone spend his/her 5 minutes to help you. Issues like "Why isn't running", "Why stuck here" will not be answered.
- Check [Frequently Asked Questions (FAQ)](https://github.com/LmeSzinc/AzurLaneAutoScript/wiki/FAQ_en_cn).
- Check updates of Alas, ensure it's the latest.
- Upload error logs under `log/error`, which include `log.txt` and recent screenshots. If it's an unexpected behavior not an error, provide today's log under `log` and at least one screenshot.
## Known issues
Sort by frequency
- **Unable to handle network issues**
- **Low-end PCs might have issues**, Low-end PCs have a screenshot time cost over 1s, while middle-end costs about 0.5s, high-end costs about 0.3s.
- **Exercise may too late to quit when it's going to failed**
- **NemuPlayer does not support long taps send from minitouch, unable to feed dorm**. NemuPlayer is not recommended.
- **Swipe may be treated as click if emulator stuck randomly**
## Documents
[Map detection](https://github.com/LmeSzinc/AzurLaneAutoScript/wiki/perspective_en)
The core of an Azur Lane bot is map detection. If you simply use `Template matching` to search enemies, will encounter situation that mob enemies block the boss. Alas provide a better map detection method. In `module.map_detection`, you will be able to access full map data, like this.
```
2020-03-10 22:09:03.830 | INFO | A B C D E F G H
2020-03-10 22:09:03.830 | INFO | 1 -- ++ 2E -- -- -- -- --
2020-03-10 22:09:03.830 | INFO | 2 -- ++ ++ MY -- -- 2E --
2020-03-10 22:09:03.830 | INFO | 3 == -- FL -- -- -- 2E MY
2020-03-10 22:09:03.830 | INFO | 4 -- == -- -- -- -- ++ ++
2020-03-10 22:09:03.830 | INFO | 5 -- -- -- 2E -- 2E ++ ++
```
Development documents, refer to [WIKI](https://github.com/LmeSzinc/AzurLaneAutoScript/wiki).
## Relative Repositories
- [AzurStats](https://azur-stats.lyoko.io/), An Azur Lane drop statistics platform based on Alas.
- [AzurLaneUncensored](https://github.com/LmeSzinc/AzurLaneUncensored), [For CN only] Repository for uncensoring Azur Lane CN, connecting to Alas.
- [ALAuto](https://github.com/Egoistically/ALAuto), Another Azur Lane bot for EN, not maintaining anymore. Alas imitated its structure.
- [ALAuto homg_trans_beta](https://github.com/asd111333/ALAuto/tree/homg_trans_beta), Alas introduced its homography transition into map detection.
- [PyWebIO](https://github.com/pywebio/PyWebIO), GUI framework that Alas uses.
- **GUI starts slowly, uiautomator2 starts slowly**
- **Unable to deal with network fluctuations** Reconnect popup window
- **The green face, yellow face and red face will be displayed** This is the BUG, Alas will restart the game every 2 hour to update the affections level.
- **Exercises may fail**
- **Screen swipe will not work in rare circumstances**

View File

@ -1,227 +0,0 @@
このドキュメントの翻訳は進行中です。
`2020/6/27 updated`
# AzurLaneAutoScript
Alas (アズールレーン自動化ツール / Azur Lane automation tool
##### 本家はCNサーバー用でEN, JPサーバーにも対応しています。
![gui](doc/README.assets/gui_en.png)
## 目次
1. [JPサーバーへの対応](#about-jpport)
2. [特徴](#features)
3. [インストール方法](#how-to-install)
4. [使い方](#how-to-use)
<h2 id="about-jpport">JPサーバー(日本)への対応について</h2>
- **直近のイベントについて**: 「特別演習 超空強襲波」対応(2020/6/27)
- **JPサーバー用の画像について**: 画像は追加されていますが、一部CNサーバ用のものを使用しています。そのため、CN, ENサーバーで実行できる機能がJPサーバーで実行できない可能性があります。
- **翻訳について**: GUIやドキュメントは日本語に翻訳されていません。
- **委託機能について**: JPサーバー用の委託機能にはtesseractというOCRを用いています。委託機能を有効化したい場合にはtesseractを[別途インストール](#install-tesseract)してください。
- **CNOCRについて**: 委託機能以外の場所では中国語用のOCRであるCNOCRが使われており、日本語を認識できない可能性があります。
- **確認されている問題**:
- CNOCRについて
<h2 id="features">特徴</h2>
#### 以下は日本サーバー未対応のものも含まれます。上記参照
- **Campaign**: 通常海域に対応しています。実行できるマップは`./campaign`フォルダ内で確認することができます。
- **Events**: イベント海域に対応しています。 実行できるマップは`./campaign`フォルダ内で確認することができます。
> Support「Skybound Oratorio」, specifically map D1 and D3, supporting handling of 光之壁? (Fleet is unable to proceed into square that has 光之壁. Support 开荒)
- **Daily Mission**: デイリー出撃(潜水艦以外)、演習、自動撤退を実行できます。
- **Events x3 PT**: イベント海域A1~B3を30分で実行できます。
- **Commissions**: 海域実行中20分ごとに、委託報酬、研究報酬、デイリーミッション報酬を受け取り、委託を行うことができます。
> Dispatch commision every 20 minutes during campaign, accept commission rewards, research rewards, and daily mission rewards.
- **Misc Features**
- 疲労度(気分)のコントロール: 疲労度が下がりすぎるのを防いだり、経験値を稼ぐために維持したりします。
- HPの監視: HPが低くなった際の撤退、前衛のHPコントロールを行います。
- 装備変更
- 定期的にスクリーンショットを保存
- 自動退役
- 艦船強化
- マップ攻略モード: 新しいマップにおいて星3でのクリアに挑戦できます。
<h2 id="how-to-install">インストール方法</h2>
以下の2つの方法でインストールすることができます。
※インストール方法をすべて読んでから質問などをしてください。
※性能の悪いPCだとエミュレーターが正しく動作しない場合があります。
1. 自動インストール(インストールに自信がない方向け)
2. 手動インストール
### 1.自動インストール(インストールに自信がない方向け)
* [動画チュートリアル](https://www.youtube.com/watch?v=bp4kd8P1qT4)
1. zipファイルをダウンロード [AzurLaneAutoScript.zip](https://github.com/whoamikyo/AzurLaneAutoScript/releases)
2. zipファイルをどこかに解凍してEasy_Install-V2.batを実行.インストーラーが必要なフォルダを作成します。
3. フォルダ名にスペースが入っている場所でインストーラを実行しないでください、動作しなくなります。
### 2.手動インストール
- 必要なもの
- 良いPC
- 性能の悪いPCだとエミュレーターが正しく動作しない場合があります。
- [Python](https://www.python.org/ftp/python/3.7.6/python-3.7.6-amd64.exe)
- 3.7.6 64bit を強く推奨(その他のバージョンだと動作しない可能性あり)
- PATHに追加されていること
- venvを使うことを強く推奨
- [ADB](https://developer.android.com/studio/releases/platform-tools)
- Latest
- PATHに追加されていること
- Android エミュレーター(Bluestacksでテスト済み)
- ADBデバッグが有効になっていること
- 画面サイズ 1280x720
1. **このレポジトリをクローン**
> git clone または download zip
2. **[Python](https://www.python.org/ftp/python/3.7.6/python-3.7.6-amd64.exe)をインストール**
1. 3.7.6 64bit を強く推奨(その他のバージョンだと動作しない可能性あり)
2. PATHに追加する
3. **venvで仮想環境を作成する(venvでvirtual envを作ることを強く推奨)**
1. `python -m venv path_to_your_folder\venv`
2. アクティベート(cmdの場合)
`.\venv\Scripts\activate.bat`
4. **パッケージインストール(venv アクティベート後)**
1. `pip install -r requirements.txt`
5. **Android エミュレーターを用意**
1. Bluestacksでテスト済み
2. ADBデバッグが有効にする
3. 画面サイズを1280x720にする
4. アズレンをインストール
> その他のエミュレーターの平均実行時間
| Device | Emulator Version | Android Version | ADB Screenshot | UIAutomator2 Screenshot | ADB Click | UIAutomator2 Click |
| ---------- | ---------- | -------- | ------- | ------ | ------- | ------ |
| NemuPlayer | 7.1.3 | 5.1.1 | 0.308 | 0.275 | 0.294 | 0.146 |
| LDPlayer | 3.83 | 5.1.1 | 0.329 | 0.313 | 0.291 | 0.146 |
| NoxPlayer | 6.6.0.0 | 5.1.1 | 0.339 | 0.313 | 0.505 | 0.141 |
| MuMuPlayer | 2.3.1.0 | 6.0.1 | 0.368 | 0.701 | 0.358 | 0.148 |
| Oneplus5 | | 7.1.1 | 1.211 | 0.285 | 0.447 | 0.160 |
> These are the common emulation setting that we have tested on, tested Platform Windows 10, I7-8700K, 1080ti, nvme SSD, emulator resolution 1280x720, Azur Lane 60FPS, tested on map 7-2, on average execute 100 commands in seconds.
> As screenshot recognition has a high requirement needed to run, AzurLaneAutoScript currently does not support mobile devices, you MUST use an emulator.
6. **ADB Setup**
1. [ADB](https://developer.android.com/studio/releases/platform-tools)をインストール
2. PATHに追加し、以下のコマンドでインストールを確認
`adb devices`
7. **UIAutomator2のスタートアップ**
- [UIAutomator2](https://github.com/openatx/uiautomator2)
- uiautomator2はスクリーンショットとクリックを高速化する自動テストライブラリです。
- スクリーンショットとクリックにはadbを使うこともできますが、u2より遅くなります。
- パフォーマンスの向上のためにはADBをスクリーンショットに、u2をクリックに使用することを推奨します。u2のスクショはADBより少し速い、CPUリソースは2倍多く消費する。一方クリックはu2がどちらにおいても良い。
- **スタートアップ**
- `python -m uiautomator2 init`
- インストールが完了すると出力は以下のようになります。
- ![U2](doc/quickguide.assets/u2_test.png)
- すべての接続されたデバイスに以下がダウンロードされます。
[uiautomator-server](https://github.com/openatx/android-uiautomator-server/releases) , [atx-agent](https://github.com/openatx/atx-agent), [minicap](https://github.com/openstf/minicap), [minitouch](https://github.com/openstf/minitouch)
- デバイスがエミュレーターの場合、minicapのインストールはスキップされます。
- **UIautomator2のインストールが成功したか確認する**
\dev_tools\emulator_test.py line 31にあるserialを対応するものに変更し、プロジェクトルートから以下を実行する。
`python -m dev_tools.emulator_test`
The default serial for some emulators:
| Android Emulator | serial |
|------------------|-----------------|
| NoxPlayer | 127.0.0.1:62001 |
| MuMuPlayer | 127.0.0.1:7555 |
| Bluestacks | 127.0.0.1:5555 |
| LDPlayer | emulator-5554 |
- エミュレータに新しいアプリがインストールされたことが確認できます。
![emulator_test](doc/quickguide.assets/atx.png)
- アプリを開くと起動しているか確認できます。
![emulator_test](doc/quickguide.assets/atx_running.png)
8. <strong id="install-tesseract">Tesseractのインストールオプション</strong>
- (委託機能を使わない場合は必要ありません)
- Tesseract
[https://github.com/UB-Mannheim/tesseract/wiki](https://github.com/UB-Mannheim/tesseract/wiki)
- 日本語用のデータファイルをインストールする
- select components
- additional script data => Japanese script
- additional language data => Japanese
- 環境変数を設定する
- 環境変数Pathに追加: インストール先\Tesseract-OCR
- 環境変数TESSDATA_PREFIXを新規作成: インストール先\Tesseract-OCR\tessdata
<h2 id="how-to-use">使い方</h2>
1. 自動インストールの場合
- 起動
- alas.batをダブルクリック
2. 手動インストールの場合
- 起動
- cmd内でvenvをactivate
- `python alas_jp.pyw`
> - (Not Recommeneded) to run alas.pyw throught cmd even thought Alas is using [Gooey](https://github.com/chriskiehl/Gooey) a library that converts the command line to a GUI, Alas didnt have a method for running command line before using gooey. Alas was meant to be use with gooey, as such the command line function was create hastily. Therefore, using command line to run Alas will not be easy.
> - (Not Recommended) to modify the configuration file 'config'alas.ini' and relation function in 'alas.py'
> - Multi-usage: copy alas.pyw, and rename, double-click run on it. The settings of template.ini are copied when the first run runs. The script runtime uses the ini profile of the same name.
## Known issue
Sort by frequency
- **GUI starts slowly, uiautomator2 starts slowly**
- **Unable to deal with network fluctuations** Reconnect popup window
- **The green face, yellow face and red face will be displayed** This is the BUG, Alas will restart the game every 2 hour to update the affections level.
- **Exercises may fail**
- **Screen swipe will not work in rare circumstances**
## Doc
[Map Perspective](doc/perspective.md)
`Map Perspective` is the core foundation of Azur scripts. If you simply use (Template Matching) to search for enemies, it is inevitable that in some rare cases, the BOSS will be blocked by mobs. `AzurLaneAutoScript` provides a better map recognition menthod in `module.map`, you will be able to get a more complete sea information such as:
```
2020-03-10 22:09:03.830 | INFO | A B C D E F G H
2020-03-10 22:09:03.830 | INFO | 1 -- ++ 2E -- -- -- -- --
2020-03-10 22:09:03.830 | INFO | 2 -- ++ ++ MY -- -- 2E --
2020-03-10 22:09:03.830 | INFO | 3 == -- FL -- -- -- 2E MY
2020-03-10 22:09:03.830 | INFO | 4 -- == -- -- -- -- ++ ++
2020-03-10 22:09:03.830 | INFO | 5 -- -- -- 2E -- 2E ++ ++
```
[Development](doc/development.md)
- How to add a button
- How to adapt to a new map
- How to support other server/language
## Reference
- (Not open source) http://asaiq2.lofter.com/
Ready made Azur scripts that has high completetion rate. Refer to the main functions and settings.
- https://github.com/Egoistically/ALAuto
(Archived) https://github.com/perryhuynh/azurlane-auto
EN Server script, use to mimic server architect.

Binary file not shown.

Before

Width:  |  Height:  |  Size: 106 KiB

After

Width:  |  Height:  |  Size: 90 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 464 KiB

After

Width:  |  Height:  |  Size: 97 KiB