Getting Started | User Manual
About 1615 wordsAbout 5 min
Getting Started
Prerequisites
1. Check Your System
| Windows | macOS | Linux | Android | |
|---|---|---|---|---|
| Required | Windows 10+ | Try at own risk | Try at own risk | Android 10+ |
| Environment | Yes | Yes | Yes | No |
| Emulator | Yes | Yes | Emulator or containerized Android | No |
| Usage | GUI or CLI | GUI or CLI | GUI or CLI | GUI |
| Also needs | None | None | None | Shizuku or root (see the note below) |
| Notes |
|---|
| Windows: Most users should download the x86_64 build |
| Mac: MaaKEDR supports both Apple Silicon and Intel Macs Intel Mac users are advised to install Windows via Boot Camp and use the Windows version of MaaKEDR with an emulator |
Android: MaaKEDR ships an Android client (see Releases; MaaKEDR-android-arm64-v8a-<version>.apk for phones, MaaKEDR-android-x86_64-<version>.apk for x86 emulators)Requires Android 10+ (background mode only; the system virtual display needs API 29); grant notification permission and add the app to the battery allowlist on first launch, then authorize via Shizuku or root |
2. Install Runtime Dependencies
Note
You can skip this section for now. After downloading and extracting MaaKEDR, run the dependency installer script first. Only come back here if the script fails.
Launcher | Windows | macOS | Linux | |||
|---|---|---|---|---|---|---|
MFAA | MXU | MFAA | MXU | MFAA | MXU | |
VCRedist | Download vc_redist.x64 | No | ||||
.NET | Yes | No | Yes | No | Yes | No |
Python | Bundled — no action needed | Python 3.13 required | ||||
VCRedist x64
Windows users must install VCRedist x64. This is required to run MaaKEDR (regardless of launcher choice).
Installation details
- Direct download: click vc_redist.x64 and install
winget(admin terminal):winget install Microsoft.VCRedist.2017.x64
.NET
If you use the MFAA GUI, you need to install .NET 10 Desktop Runtime.
Installation details
- Download from the .NET official download page — choose the .NET 10 Desktop Runtime for your system.
- (Windows only)
winget(admin terminal):winget install Microsoft.DotNet.DesktopRuntime.10
Python
Python is bundled in the Windows and macOS release packages — no separate installation required. The Linux release does not bundle Python; install Python 3.13 manually.
3. Download the Right Version
Download MaaKEDR from the GitHub Releases page. Each release provides two GUI frontends — download only one:
Tip
Trust only the official channels: MaaKEDR is released through GitHub Releases and Mirror酱 (a partner channel with content identical to the official one); some GUIs support in-app updates via Mirror酱. Downloads from other unofficial sources (lookalike sites, file-hosting reshare) carry security risks — verify the app identifier before installing.
| Frontend | Suffix | Description |
|---|---|---|
| MFAA | -MFAA | GUI, requires .NET Desktop Runtime, richer interface |
| MXU | -MXU | GUI (Tauri + React), no additional dependencies |
| Platform | Download |
|---|---|
| Windows x86_64 | MaaKEDR-win-x86_64-v*-MFAA.zip or -MXU.zip |
| Windows ARM64 | MaaKEDR-win-aarch64-v*-MFAA.zip or -MXU.zip |
| macOS Intel | MaaKEDR-macos-x86_64-v*-MFAA.tar.gz or -MXU.tar.gz |
| macOS Apple Silicon | MaaKEDR-macos-aarch64-v*-MFAA.tar.gz or -MXU.tar.gz |
| Linux x86_64 | MaaKEDR-linux-x86_64-v*-MFAA.tar.gz or -MXU.tar.gz |
| Linux ARM64 | MaaKEDR-linux-aarch64-v*-MFAA.tar.gz or -MXU.tar.gz |
| Android universal | MaaKEDR-android-universal-v*.apk (pick this if unsure) |
| Android arm64-v8a | MaaKEDR-android-arm64-v8a-v*.apk (most phones) |
| Android x86_64 | MaaKEDR-android-x86_64-v*.apk (emulators on PC) |
How to check your Mac processor architecture
- Click the Apple logo in the top-left corner.
- Select "About This Mac".
- Check the processor information.
- Intel processor → download
-macos-x86_64-- Apple Silicon (M1, M2, etc.) → download
-macos-aarch64-
4. Emulator & Device Support
| Windows | macOS | Linux | Android | |
|---|---|---|---|---|
| Emulator | Yes (major ones) | Yes (major ones) | DIY | N/A |
| ADB required | Yes | Yes | Yes | No |
| Shizuku required | No | No | No | Yes |
MaaKEDR connects to emulators/devices via ADB. Recommended emulators:
- MuMu 12
- BlueStacks 5
- LDPlayer 9
- NoxPlayer
Refer to the MAA documentation for emulator compatibility details.
5. Set the Correct Resolution
MaaKEDR requires a 16:9 landscape resolution. The recommended (and minimum) resolution is 1280x720. Issues caused by incorrect resolution will not be addressed.
Warning
Make sure your emulator is in landscape (tablet) mode, not portrait (phone) mode!
6. Getting Started
Important
Do not run the program directly from within the archive!
Extract the archive to a dedicated folder. Recommended path: D:\MaaKEDR (Windows) or ~/MaaKEDR (macOS/Linux). Avoid paths that require administrator privileges (e.g. C:\Program Files\).
Windows
Extract and run maakedr.exe.
macOS
Details
Open Terminal and extract:
mkdir -p ~/MaaKEDR tar -xzf ~/Downloads/MaaKEDR-macos-*.tar.gz -C ~/MaaKEDREnter the directory and launch:
cd ~/MaaKEDR ./maakedrGatekeeper warning:
On macOS 10.15+ you may see "cannot be opened because the developer cannot be verified". To bypass:
sudo xattr -rd com.apple.quarantine ~/MaaKEDR/maakedr
Linux
Same as macOS — extract the appropriate archive and run ./maakedr.
Android
The Android build is a separate thing: no PC, no emulator, no extraction — just install the APK.
Download the APK matching your architecture from Releases: arm64-v8a for phones, x86_64 for x86 emulators, universal if unsure.
- On first launch, grant notification permission and add the app to the battery allowlist. Background idling, scheduled starts and progress notifications all depend on them.
- Authorize with Shizuku or root and wait for the service to connect. Shizuku must be installed and started separately:
- Android 11+: start it on-device via wireless debugging, no PC needed
- Older versions without root: start it from a PC over ADB
- See the Shizuku documentation
- The task resources are unpacked automatically on first launch.
- Pick a server, tick the tasks you want and start — no ADB connection to configure.
Note
Configuration is essentially the same as on desktop, but resources are bundled into the APK. There is no hot update and no MirrorChyan delta update — switching versions means downloading and installing the APK again. If the device still shows old content, clear MaaKEDR's app data and reopen it.
Warning
Without Shizuku or root the APK installs but cannot run tasks (it has no permission to capture the screen or tap). In that case use the desktop build instead.
7. Configure MaaKEDR
First Launch
On first launch, MaaKEDR automatically initializes and creates the config/ directory. Wait for "AgentServer started" in the log panel, and do not click "Stop" until "All tasks completed" appears.
Resource Type
Select the server version of 雪松 (KEDR) installed in your emulator:
- Official (
base) - Bilibili (
bilibili) - TapTap (
taptap)
Connection
MaaKEDR needs a correct ADB connection to your target emulator. In most cases, just keep your target emulator running and click "Refresh".
- Refresh: Rescan all running emulators
- Custom: Modify ADB parameters (usually not needed)
- Reconnect: Reconnect to the selected emulator
Task List
MaaKEDR provides these automation tasks:
| Task | Description |
|---|---|
| Launch Game | From launcher to main menu |
| Claim Rewards | Daily check-in, weekly, battle pass, mail, dispatch |
| Farm Resources | Auto-battle with stamina management |
| Remaining Stamina | Fixed stamina-drain mode to use up leftover stamina |
| Event Stage | Event stage sweeps (3/day, no stamina cost) |
| Event Shop | Auto-buy fixed-guarantee items in the event shop |
| PVP | Arena auto-battle |
| Stamina Info | Read home-screen stamina and report refill time |
Important
Most tasks require proper configuration before use. Read each task's description carefully and adjust settings according to your needs.
Configuration Files
On first launch, MaaKEDR generates configuration files in the config/ directory. You can edit these with a text editor.
config/pip_config.json
pip installation settings. In most cases, no changes are needed.
{ "enable_pip_install": true, // Enable pip install, default true "mirror": "https://pypi.tuna.tsinghua.edu.cn/simple", // PyPI mirror "backup_mirror": "https://mirrors.ustc.edu.cn/pypi/simple", // Backup mirror }
FAQ
Cannot connect to emulator
- Make sure ADB debugging is enabled in your emulator
- Try
adb devicesto verify the connection - Check the ADB port: MuMu uses
127.0.0.1:16384, BlueStacks uses127.0.0.1:5555
Tasks fail during execution
- Ensure the game is on the correct screen (main menu or target feature page)
- Check screenshots in the
debug/directory to verify recognition accuracy - Review
maafw.log(project root) for error details
