Player Guides Overview¶

Welcome to the player guides! To connect to custom Sparkle servers, you need to complete two main steps:

Client Installation: Download and install the specific official game client version.
Client Configuration: Configure redirection on your device to point to the custom server.

Below you will find the starting points for both steps, as well as an overview of connection methods.

1. Client Installation¶

Before you can connect, you must install the compatible game client on your device.

Android Installation: See the Android Installation Guide for sideloading or downloading v3.6.0.
iOS Installation: See the iOS Installation Guide for Fiddler-based client downgrade instructions.

Important

Compatible Client Version & OS Support

Game Client Version: You must use a completely unmodified, official v3.6.0 KRFN client. The final official version (v3.7.0) is not supported.
Operating System Version:
- Android: Supports Android 4.4.4 up to Android 13. Android 14 and newer are not natively supported (see the VMOS Pro workaround below).
- iOS: Supports all iOS versions.

2. Client Configuration¶

Once the compatible client is installed, you need to configure your device to route traffic to the custom server.

Method Selection Flowchart¶

Use the flowchart below to identify the most suitable connection method based on your device, OS version, and setup preferences.

flowchart TD
    Start(["Start Client Configuration"]) --> OS{"Which OS is your device running?"}

    OS -->|"Android"| AndVersion{"Which Android version?"}
    OS -->|"iOS"| iOSPreference{"What is your setup preference?"}

    %% Android Branch
    AndVersion -->|"Android 14+"| VMOS["VMOS Pro (Android 9 VM)\n(Run game inside virtual environment)"]
    AndVersion -->|"Android 11 to 13"| And11_13{"Choose priority:"}
    And11_13 -->|"Ease of use"| Router["Sparkle Router (Cross-Platform)\n(Simple browser-based launch)"]
    And11_13 -->|"Stability"| SAF["Launcher SAF\n(Recommended launcher-based launch)"]

    AndVersion -->|"Android 6.0.1 to 10.x"| KRFNLauncher["KRFN-launcher\n(Recommended easy GUI launcher)"]
    AndVersion -->|"Android 4.4.4 to 6.0"| PyDroid["Legacy Manual Script (PyDroid 3)\n(Robust fallback method)"]

    %% iOS Branch
    iOSPreference -->|"I want the easiest setup possible"| Router
    iOSPreference -->|"I want to launch the app directly without a browser (Advanced)"| iOSMITM["MITM Redirection (Shadowrocket / Charles)\n(Stable, direct application launch)"]

    classDef recommended fill:#ff99c8,stroke:#ff5c8a,stroke-width:2px,color:#000;
    class SAF,KRFNLauncher,Router recommended;

Comparison of Connection Methods¶

The table below summarizes the difficulty, pros, cons, and documentation links for each available connection method.

Method	Target OS	Difficulty	Pros	Cons	Guide
Sparkle Router	iOS (All versions) Android 13 & older	Very Easy	• No client patching or proxy configuration required. • Launch instantly via your web browser. • Works on stock iOS without jailbreak.	• Must open the browser router interface before every launch. • Redirection active for only a 30-second window. • May be unstable on certain iOS environments.	View Guide
Launcher SAF	Android 11 to 13	Easy	• No root access required. • Safe, on-the-fly in-memory metadata patching.	• Launch success rate is ~80% (may require multiple retries). • Must always boot the game through the launcher app.	View Guide
KRFN-launcher	Android 6.0.1 to 10.x	Easy	• No root access required. • Intuitive GUI with customizable configuration. • Extremely stable connection once configured.	• Incompatible with Android 11 and newer. • Must always boot the game through the launcher app.	View Guide
Legacy Script (PyDroid)	Android 4.4.4 to 10.x	Moderate	• A robust, time-tested fallback method. • Essential if other launchers fail to work on your device.	• Requires installing PyDroid 3 (Python environment). • Steps are semi-manual; throws a dummy error at the end (safe to ignore). • Emulators are not supported.	View Guide
MITM Redirection	iOS (All versions) Android (Root required)	Advanced	• Launch the game client directly from the home screen icon. • Highly stable and operates completely transparently after setup.	• Extremely high setup complexity. • Requires generating, installing, and systemizing custom Root CA certificates. • Requires paid third-party apps (e.g., Shadowrocket) on iOS.	Android: View Guide iOS: View Guide

Connection Endpoints¶

To manually configure your connection or view custom server settings, see Connection Endpoints & Settings.

Tip

Why Directly Patching the Client Is Not Possible

The game client is protected by highly secure encryption and integrity verification mechanisms. As a result, directly patching the application binary itself (such as modifying the APK/IPA file to change hardcoded endpoints) is extremely unstable and is not a viable method.

Therefore, all connection methods documented here must rely on alternative approaches:

Dynamic Memory Patching: Modifying connection endpoints in memory on the fly during launch (using custom helper launchers).
Network-Level Redirection: Rerouting API and asset traffic in-transit (using Sparkle Router or MITM proxies).

Tip

Android 14+ Workaround: Virtual Machine (VMOS Pro)

Since native support for Android 14+ is currently a work in progress, you can bypass the OS limitation by running an Android 9 virtual environment:

Download and install VMOS Pro.
Inside VMOS Pro, add a virtual machine and select the Android 9 Trial Edition (尝鲜版). Note: You must use this exact version; other Android versions are incompatible.
Install the unmodified official game client (v3.6.0) inside this virtual machine.
Configure your dedicated connection/VPN on the host (physical) device first, then return to the virtual machine.
Launch the game inside the VM and play!

If you encounter any issues or have questions, feel free to reach out to the developer community on our Discord server!