KuyFox Installation & Flashing Guide

This document explains how to deploy and execute KuyFox on an Android device via Custom Recovery (OrangeFox, TWRP, or PBRP).

📋 Device Requirements

Before starting, ensure your test device meets the following criteria:

1. Custom Recovery Installed:
   • OrangeFox Recovery (Highly Recommended)
   • TWRP (Team Win Recovery Project)
   • PitchBlack Recovery (PBRP)
2. Decrypted /data Partition:
   • If your test phone uses a lockscreen PIN/Pattern/Password, enter it when booting into recovery to unlock storage decryption.
3. Internal Storage / USB OTG:
   • At least 100 MB of free storage for profile databases and state archives.

⚡ Method 1: Flashing via ZIP Package (Recommended)

This is the fastest, cleanest, and most automated deployment method. The installer script within the ZIP configures execution permissions and sets up global shortcuts automatically.

Steps:

1. Copy KuyFox-v1.0.zip to internal storage (/sdcard/) or a USB OTG drive.
2. Boot into Recovery mode (power off the phone, then hold Power + Volume Up / Down depending on your phone model).
3. Open the Install / Files menu in recovery.
4. Select the KuyFox-v1.0.zip file.
5. Swipe the confirmation slider (Swipe to Flash).
6. The installer will:
   • Extract the KuyFox engine to /sdcard/KuyFox/.
   • Set execution permissions (chmod 755).
   • Inject auto-load aliases into OrangeFox terminal (/sdcard/Fox/fox.bashrc) so the kuyfox shortcut is immediately active.
   • Add a boot hook in /sdcard/Fox/init.d/99kuyfox to recreate /sbin/kuyfox automatically on recovery reboots.
   • Install persistent binary wrappers in /system/bin/kuyfox and /sdcard/.bashrc.
   • Activate directory protection so /sdcard/Fox and /sdcard/KuyFox are never wiped during testing cleanups.
7. Once you see [SUCCESS] KuyFox Installation Finished!, no reboot is required; proceed directly to terminal execution.

🛠️ Method 2: Manual Folder Extraction (Without Flash)

If you prefer not to flash the ZIP package, copy the KuyFox directory structure manually:

1. Extract the ZIP archive on your PC or using a mobile file manager.
2. Ensure the folder is located at:

   /sdcard/KuyFox/
   ├── core/
   ├── database/
   ├── config.cfg
   ├── backup_config.cfg
   └── kuyfox.sh
   

3. Open Recovery Terminal and run:
   Terminal

   sh /sdcard/KuyFox/kuyfox.sh
   

🚀 How to Launch KuyFox in Recovery

Once installed, there are 2 practical ways to launch the KuyFox terminal interface in recovery:

🔹 Method 1: Direct Execution (Fastest — No Manual Partition Mount)

1. Open the Terminal in recovery:
   • OrangeFox: Menu (three lines) -> Terminal
   • TWRP: Advanced -> Terminal
2. Type the following command and press Enter:
   Terminal

   sh /sdcard/KuyFox/kuyfox.sh
   

   This method runs immediately without needing to mount any partition manually. When spoofing operations run, the KuyFox engine automatically mounts /system and /vendor in RW mode in the background.

🔹 Method 2: Use Short kuyfox Command (Via System Mount)

1. In the main recovery menu (OrangeFox / TWRP), open the Mount menu and check System.
2. Open the Terminal, then simply type:
   Terminal

   kuyfox
   

3. Press Enter. The persistent binary wrapper is stored in the ROM partition (/system/bin/kuyfox). Checking the System partition instantly activates the kuyfox shortcut in $PATH.