Installation Guide

NIKKEAutoScript (NKAS) Installation Guide

Need Help
If you encounter problems during installation or use, you can get help through the following methods:

• Submit an issue at GitHub Issues
• Join the QQ support group: 823265807

---

Installation Overview

• Windows Users: Please download the installation package from Releases (Windows only)
• Linux Users: Install via Docker, no precompiled package required

💡 Important Note:
Currently supports PC clients, ARM-based emulators, and Android devices. x86 emulators are not supported.
This project is based on Alas (old version). For device compatibility, refer to Alas Device Support Documentation.
Tested and verified emulators: MuMu5.0, MuMu12, and BlueStacks 5 International (Android 13).

---

Windows Installation Guide

1. Get the Installation Package

1. Visit the GitHub Releases page
2. Download the 7Z archive with NKAS_xxx in the name; if unsure, download NKAS_xxx_full-cn (⚠️ Do NOT download “Source Code”)
3. Extract the package to a local folder (English-only path recommended)
   • Requires approximately 2 GB of disk space

⚠️ Path Warning
Always extract to a pure English path; non-English characters may cause installation failure.

2. Edit Installation Configuration

⚠️ Skip this step if you downloaded the NKAS_xxx_full-cn package.

1. Locate the config/deploy.yaml file in the extracted folder.
2. Modify according to your network environment (international users can skip this).

Required Configuration for Mainland China Users

Recommended modifications:

Repository: 'https://gitee.com/megumiss/NIKKEAutoScript'

PypiMirror: 'https://mirrors.aliyun.com/pypi/simple'

💡 Tip
You can copy the contents of deploy.template-cn.yaml to deploy.yaml to apply all domestic source settings.

3. Complete Installation

⚠️ Skip this step if you downloaded NKAS_xxx_full-cn.

1. Double-click updater.bat in the root directory.
2. Wait for installation (2–3 minutes). Progress bars indicate success.

⚠️ Do Not Close the Command Window
The installer will automatically close when finished.

4. Launch NKAS

After installation, double-click nkas.exe. If using the PC client, run it as Administrator.

💡 Alternative Launch Option
If your antivirus flags nkas.exe, use deploy/launcher/nkas.bat instead.

---

Troubleshooting Installation

❌ Antivirus False Positive

Issue: Antivirus reports nkas.exe as malware.
Solution: Add it to the whitelist or use the .bat launcher.

💡 Explanation:
nkas.exe is a batch-packed executable and safe to use.

❌ Installation Error

Example Errors:

Fix:

1. Check deploy.yaml settings.
2. Verify domestic mirrors are configured.
3. Re-run updater.bat.

❌ PyPI Package Download Failure

ERROR: Could not find a version that satisfies the requirement XXX

Solution:

1. Re-run updater.bat.
2. Try another mirror source:

Mirror	URL
Aliyun	https://mirrors.aliyun.com/pypi/simple/
Tsinghua	https://pypi.tuna.tsinghua.edu.cn/simple
Douban	https://pypi.douban.com/simple/

❌ White/Black Screen After Launch

Fix:

1. Ensure path is English-only.
2. Re-run updater.bat.
3. Press CTRL+R to refresh.
4. Run netsh winsock reset then restart.
5. Try changing DNS or fixed IP.
6. Change WebuiHost or WebuiPort in deploy.yaml.

---

Linux Installation (Ubuntu)

1. Prepare Environment

1.1 Update System

sudo apt update && sudo apt upgrade -y

1.2 Install Git

sudo apt install git -y

1.3 Install Docker

(Instructions identical to original Chinese content, translated)

1.4 Add User to Docker Group

1.5 Install docker-compose

1.6 Verify Docker Environment

2. Clone NKAS

git clone https://github.com/megumiss/NIKKEAutoScript
cd NIKKEAutoScript

3. Run

# copy config file
mv -f config/deploy.template-docker.yaml config/deploy.yaml
# pull image
docker pull megumiss/nkas:latest
# start
docker compose up -d

Access http://127.0.0.1:12271.

---

Migration from Old NKAS

1. Copy deploy.yaml, nkas.json, nkas.acc from old version.
2. Paste into new config folder.
3. Run installation normally.

💡 Most settings will carry over, but some may need reconfiguration.