StikDebug-Guide: Pairing File Instructions

Hey there! 👋 If you're looking to get StikDebug up and running with your iOS or iPadOS device, you're in the right place. This guide will walk you through the process of creating a pairing file—a crucial step for letting StikDebug communicate with your device remotely. Let's break it down step by step, in the order you'll need to do things, and highlight all the important bits!

---

What's This All About?

StikDebug needs a special file, called a pairing file, to talk to your iPhone or iPad from your computer. Without this file, StikDebug simply won't work. As the guide says:

"idevice pair allows us to create a pairing file for programs like StikDebug to talk to your device remotely. This is required to use StikDebug, otherwise it will not function."

So, if you want to use StikDebug, you must follow these steps!

---

Before You Start: Device Preparation

Before you even touch your computer, you need to get your iOS/iPadOS device ready. Here's what you need to do:

1. Set a passcode on your device.
2. Sideload an app that has the get-task-allow entitlement (this just means an app that lets you debug or develop).
3. Enable Developer Mode on your device.
   • You'll find this in Settings → Privacy & Security after you've sideloaded the app.

The guide emphasizes:

"First, set a passcode on your device, sideload an app with the get-task-allow entitlement, and enable Developer Mode on your iOS/iPadOS device (found in Settings -> Privacy & Security after sideloading an app). Then, follow the instructions below."

---

Step 1: Download the Right Tools

Depending on your computer's operating system, you'll need to download the correct version of iDevicePair. Here are the links:

• Windows: iDevicePair--windows-x86_64.exe
• macOS: iDevicePair--macos-universal.dmg
• Linux:
  • x86_64: iDevicePair--linux-x86_64.AppImage
  • AArch64: iDevicePair--linux-aarch64.AppImage

---

Step 2: Follow the Instructions for Your OS

Let's go through each operating system one by one. 🖥️

---

🪟 Windows (64-bit)

1. Install iTunes
   Download and install iTunes from Apple's website.

   This is necessary for your computer to talk to your iOS device!

2. Download iDevicePair
   Get iDevicePair--windows-x86_64.exe and put it somewhere safe.

3. Connect Your Device
   Plug your iPhone/iPad into your computer with a cable.

   • If you see a prompt on your device, tap Trust and enter your passcode.

4. Open iDevicePair
   Unlock your device, then open idevice pair on your computer.

   • Select your device from the drop-down menu.

5. Generate the Pairing File
   Make sure your device is unlocked and on the home screen.

   • Click Generate.
   • If you're already using an app like SideStore that uses a pairing file, click Load instead.
   • When prompted on your device, tap Trust.
   • Your pairing file should now appear!

6. Install for StikDebug
   Keep your device unlocked and on the home screen.

   • Scroll to the StikDebug section and click Install.
   • You should see the word "success" in green.

   "The word 'success' should appear in green."

---

🍏 macOS

1. Download and Install iDevicePair
   Download iDevicePair--macos-universal.dmg, open it, and drag idevice pair to your Applications folder.

2. Connect Your Device
   Plug in your iPhone/iPad.

   • Tap Trust and enter your passcode if prompted.

3. Open iDevicePair
   Unlock your device, open idevice pair, and select your device from the drop-down.

4. Generate the Pairing File
   Make sure your device is unlocked and on the home screen.

   • Click Generate (or Load if you already use a pairing file with another app).
   • Tap Trust on your device when prompted.
   • Your pairing file should appear.

5. Install for StikDebug
   Keep your device unlocked and on the home screen.

   • Scroll to the StikDebug section and click Install.
   • Look for "success" in green.

---

🐧 Linux

1. Install usbmuxd
   Open a terminal and run:

   sudo apt install -y usbmuxd
   

   usbmuxd is a tool that helps your Linux computer communicate with iOS devices over USB.

2. Download and Prepare iDevicePair
   Download the correct version for your system (x86_64 or AArch64) and make it executable.

3. Connect Your Device
   Plug in your iPhone/iPad.

   • Tap Trust and enter your passcode if prompted.

4. Run iDevicePair
   Unlock your device, run idevice pair, and select your device from the drop-down.

5. Generate the Pairing File
   Make sure your device is unlocked and on the home screen.

   • Click Generate (or Load if you already use a pairing file with another app).
   • Tap Trust on your device when prompted.
   • Your pairing file should appear.

6. Install for StikDebug
   Keep your device unlocked and on the home screen.

   • Scroll to the StikDebug section and click Install.
   • Look for "success" in green.

---

Key Points to Remember

• Always keep your device unlocked and on the home screen during the process.
• If you're already using a pairing file with another app (like SideStore), use the Load option instead of Generate.
• The process is almost identical across Windows, macOS, and Linux—just the setup steps differ a bit.
• Seeing "success" in green means you're done! 🎉

---

Final Thoughts

Setting up StikDebug might seem a bit technical, but if you follow these steps in order, you'll be ready to go in no time. Remember:

"This is required to use StikDebug, otherwise it will not function."

So don't skip any steps, and you'll have your device paired and ready for remote debugging!

If you get stuck, double-check that your device is unlocked, on the home screen, and that you've tapped Trust whenever prompted. Good luck, and happy debugging! 🚀