> **Asking For Help**
>
> If you have any problems during the installation, create a new ISSUE or join Discord ALAS Dev. Link is in README.md.
>
> Notice:
>
> - Feel free to join Discord channel, ALAS Dev, but you have to react with TICK in rules channel to unlock all the channels. To avoid bot spam, you need to be a member for at least 5 minutes to speak.

# Easy Install Method

Easy installer is only available for Windows. Mac and Linux need to follow the manual installation tutorial.

### Download Installer

Get the latest easy installer on [Github Releases](https://github.com/LmeSzinc/AzurLaneAutoScript/releases), but do not download source code in zip.

Unzip installer. Alas requires about 1.5 GB for full installation.

### Edit Installer Settings

Read the comments in `config/deploy.yaml`, and modify it according to yourself. This is considered as the use threshold of Alas.

For EN users, no need to modify, keep them as default.

### Use Installer

Double click to open `Alas.exe`. It will do staffs from pulling repositories, install environments, to preparing ADB. Wait A few minutes, Alas Desktop App will be opened.

If you encountered any trouble, check your deploy settings and re-open.

<img src="Installation_cn.assets/install.png" alt="install" height="360" />

<img src="Installation_cn.assets/install_finish.png" alt="install_finish" style="zoom: 50%;" />

### Frequently Asked Questions (FAQ)

> #### My anti-virus software says Alas.exe is a virus
>
> Add it to white list. Alas.exe is a bat file converted to exe file, might have false positives on some anti-virus software. If you are still worrying, replace `Alas.exe` with `deploy/install/Alas.bat`, which does the same thing.

> #### I have problems during the installation
>
> <img src="Installation_cn.assets/install_error.png" alt="install_error" height="360" />
>
> Just as the installer said, you need to check your settings in  `config/deploy.yaml`  and re-open `Alas.exe`. If you encountered network issues, just re-open to retry.

> #### I got a white screen in Alas
>
> <img src="Installation_cn.assets/install_white.png" alt="install_white" height="360" />
>
> Try `CTRL+R` to refresh and checkout [Issue #876](https://github.com/LmeSzinc/AzurLaneAutoScript/issues/876#issuecomment-1011963386).
>



## Uninstall Alas

Everything in the installer are portable. Just delete them to uninstall. You can also copy an installed Alas to another computer, making use of this feature.

If files are occupied during the delete, open `console.bat` and try these commands.

```
adb kill-server
taskkill /f /im alas.exe
taskkill /f /im python.exe
```



## Start Using Alas

### Configure Emulator

Install an emulator, and have Azur Lane installed.

1. Goto the settings of your emulator. Set resolution to `1280x720` and use `Tablet Mode`.

   <img src="Installation_cn.assets/emulator_1.png" alt="emulator_1" height="360" />

2. If you are using BlueStacks or LDPlayer, enable ADB too.

   <img src="Installation_cn.assets/emulator_2.png" alt="emulator_2" height="360" />

3. If you are using MuMu12, close `App keep alice`.

   <img src="Installation_cn.assets/emulator_mumu12.png" alt="emulator_3" height="360" />

### Enter Alas

Double click `Alas.exe` to start Alas.

When Alas starts, it will update automatically, you don't need to do anything. In most situation, Alas is able to update itself by this way. But if there are big changes on Alas App, you will need to re-download and re-install.

1. Choose your language.
2. Select your first Alas instance.

<img src="Installation_cn.assets/usage_1.png" alt="usage_1" style="zoom:50%;" />

### Configure Alas

1. Enter the `Alas` on sidebar.
2. Configure your `Serial`, `Package Name`, `Game Server` and `Emulator Settings` according to the help text.
3. If you are confused about the configurations, you can keep all the default settings and Alas will automatically recognize your environment.

- For MuMu12 users, Alas is recommended to detect the emulator type automatically by itself, and you will need to fill in the 'Serial' of the instance that runs the game. When running the emulator, it can be found in the upper right corner of `MultiPlayer`.

![setting_1](Installation_cn.assets/setting_1_en.png)
![setting_2](Installation_cn.assets/setting_2_en.png)
![setting_2](Installation_cn.assets/emulator_mumu12_2.png)

### Run Performance Test

1. Enter the `Performance Test` on sidebar. Your account needs to unlock W7, before running a performance test.
2. Keep the default settings, press `Start`, wait.
3. Looking at the results of the performance test, we need to choose the fastest screen shot method and control method. Results can be very depending on PC specs and emulators. In general, screen shot time cost + control time cost < 350 ms is enough for ALAS to run a little faster than human. If you find ALAS slow, you should choose a faster screen shot method or upgrade PC specs.

![performance_test_1](Installation_cn.assets/performance_test_1.png)

4. Enter the `Alas` on sidebar. 
5. On `Emulator Settings` set the fastest screen shot method and control method.

![performance_test_2](Installation_cn.assets/performance_test_2.png)

### Enable Tasks

1. Choose the task you would like to run. You could have multiple tasks enabled. Alas will schedule them automatically.
2. Enable the task.
3. Edit the settings below.

![usage_3](Installation_cn.assets/usage_3.png)

## Start Running

1. Goto `Overview`.
2. Tasks you enabled are shown in scheduler queue.
3. Click `Start`, and Alas scheduler will start running.

![usage_4](Installation_cn.assets/usage_4.png)



## Immigrate from Old Alas App

Before re-installation, find deploy settings `config/deploy.yaml` and user setting `config/alas.json`. If you have multiple Alas running,  `config/*.json` are required, such as ``config/alas2.json``.

Copy them to the `config` folder of new installer, and install as usual.


## Immigrate from Manual Alas Installation

If you are developing or going to develop Alas, you've probably have cloned the repository of Alas, created a virtual environment, installed the dependencies, and deployed ADB. There's no need to install them again.

1. Copy the deploy settings `config/deploy.yaml` to the `config` folder of the Alas you've cloned. Edit  `GitExecutable`, `PythonExecutable`,  `AdbExecutable` in it.
2. Find `toolkit/WebApp/alas.exe`, create a shortcut for it. Right click the shortcut, click `Properties`, change `Start at` to the folder of your Alas clone.
3. Double click shortcut to run.

Notice: Using the shortcut will bypass the Alas launcher, causing you to manually update Alas. This approach is for developers only.



## Control Alas Remotely via Web

<img src="Installation_cn.assets/alas_remote.png" alt="alas_remote" height="640" />

The essence of Alas App or the essence of Electron is Node.js server + Chromium browser. So you will need one of the following ways to start the web server of Alas.

- Open Alas App Client
- Open `console.bat` and run `python gui.py`

And you will be able to access Alas on `http://127.0.0.1:{port}` , port is 22267 by default.

If you have a static public IP, you can access Alas on `http://{ip}:{port}` from other devices. If don't you will need a reverse proxy to expose a local server behind a NAT, such as [frp](https://github.com/fatedier/frp).

Notice: It's dangerous to expose Alas to the public network. Everyone is able to stop your Alas or edit your settings. What's worse, Alas can't defend injects and attacks.

## Install in Linux with Docker

[See full article](Installation_en_docker)

## Manual Installation Tutorial

Manual installation tutorial is for developers only, requiring basic programing knowledge. If you are not developing nor going to develop Alas, please use easy installer and ignore this part. Mac and Linux users need to install manually too.

### Get Alas

1. Use Git to clone, do not download from source.

   Suppose you are going to install in `D:/AzurLaneAutoScript`, then execute this in `D:/`.

```
git clone https://github.com/LmeSzinc/AzurLaneAutoScript
```

	2. Enter the directory.

```
cd AzurLaneAutoScript
```

### Prepare Environment

Create a new virtual environment instead of an existing one on your computer, because Alas is using old Python and dependencies. Let's take Anaconda as an example to create a virtual environment. Of course, you could use others like venv.

1. Create a virtual environment named `alas` (Any other name is OK). Python version must be 3.7.6. To avoid troubles, don't use 3.8 or higher.

```
conda create -n alas python==3.7.6 -y
```

2. Activate the environment you have just created.

```
conda activate alas
```

3. Install dependencies.

```
pip install -r D:\AzurLaneAutoScript\requirements.txt
```

> If pip says it need to be updated, like this.
>
> ```
> WARNING: You are using pip version 21.0.1; however, version 21.1.3 is available.
> ```
>
> Execute this, or just ignore.
>
> ```
> python -m pip install --upgrade pip
> ```

> If you failed to install `Python-Levenshtein` because `Microsoft Visual C++ 14.0 is required`, download its wheel file [here](https://www.lfd.uci.edu/~gohlke/pythonlibs/) and install.
>
> ```
> pip install python_Levenshtein-0.12.0-cp37-cp37m-win_amd64.whl
> ```

### Prepare Emulator

1. Install an emulator, and have Azur Lane installed.

   Goto the settings of your emulator. Set resolution to `1280x720` and use `Tablet Mode`.

   If you are using BlueStacks or LDPlayer, enable ADB too.

2. Get ADB.

   Get the latest ADB [here](https://developer.android.com/studio/releases/platform-tools), set it in your environ variables.

3. Replace the ADB of emulator

   Different version of ADB will kill each other when starting. Chinese emulators (NoxPlayer, LDPlayer, MemuPlayer, MuMuPlayer) use their own adb, instead of the one in system PATH, so when they start they kill the adb.exe Alas is using.

   Replace the ADB in your emulator with the latest one.

   Take NoxPlayer as an example. There are 2 ADB in nox install folder, `adb.exe` and `nox_adb.exe`. Make backups for these 2 files and delete them. Copy two `adb.exe` to your nox install folder, and rename them to `adb.exe` and `nox_adb.exe`.

   After that, run this command to test.

```
adb devices
```

​	If you see output like this, it means the replacement success.

```
List of devices attached
127.0.0.1:59865 device
```

​	If you have output like this, it means the replacement failed. There may be files that haven't been replaced.

```
adb server version (36) doesn't match this client (41); killing...
```

4. Install [uiautomator2](https://github.com/openatx/uiautomator2), an auto-testing library. Before installation, open your emulator.

```
python -m uiautomator2 init
```

​	After the installation, there will be an app called `ATX` on your emulator.

### Run Alas

1. Activate virtual environment and execute:

```
python gui.py
```

​	Then Alas is available on `http://127.0.0.1:{port}`. Port is default to 22267.

2. Configure Alas, referring to "Start Using Alas" part.

### Use Alas Desktop App

Desktop App cross-platform, can be build in Windows, Mac and Linux.

1. Enter `webapp` directory, install the dependencies.

```
yarn
```

2. Build Desktop App.

```
yarn run compile
```

​	Then, desktop app will be available in `webapp/dist/{platform}`.

3. Start using it. Create a short cut, referring to "Immigrate from Manual Alas Installation" part.