diff --git a/README.md b/README.md index 2f4bacf4..03378bf9 100644 --- a/README.md +++ b/README.md @@ -17,17 +17,17 @@ - - + + - - + + - - + + - - + +
@@ -38,7 +38,7 @@ ## Features - On-device Just-In-Time (JIT) compilation for supported apps via [`idevice`](https://github.com/jkcoxson/idevice). - Seamless integration with [`em_proxy`](https://github.com/SideStore/em_proxy). - - Note: em_proxy isn't needed for StosVPN, its only kept for backwards compatibility with WireGuard + - Note: em_proxy isn't required for StosVPN, it is only kept for backwards compatibility with WireGuard - Native UI for managing JIT-enabling. - No data collection—ensuring full privacy. @@ -46,13 +46,15 @@ For detailed installation instructions, including setup with SideStore, AltStore, or Altstore PAL (EU), please refer to our [User Manual](user-manual.md).

- +     - + +  +   - +  

@@ -60,7 +62,7 @@ For detailed installation instructions, including setup with SideStore, AltStore 1. **Clone the repository:** ```sh - git clone https://github.com/0-Blu/StikJIT.git + git clone https://github.com/StephenDev0/StikJIT.git cd StikJIT ``` @@ -86,7 +88,7 @@ For detailed installation instructions, including setup with SideStore, AltStore 1. **Set up your development environment:** ```sh # Clone the repository - git clone https://github.com/0-Blu/StikJIT.git + git clone https://github.com/StephenDev0/StikJIT.git cd StikJIT # Open in Xcode diff --git a/repo.json b/repo.json index 0d1d254b..c794a1cb 100644 --- a/repo.json +++ b/repo.json @@ -1,11 +1,12 @@ { "name": "StikJIT Repository", "identifier": "com.stik.sj", - "subtitle": "AltStore/SideStore compatible source repository for StikJIT.", + "website": "https://github.com/StephenDev0/StikJIT/", + "subtitle": "Official AltSource for StikJIT.", "description": "An on-device JIT enabler for iOS versions 17.4+ (excluding iOS 18.4 beta 1), powered by idevice.", "tintColor": "#293B45", - "iconURL": "https://github.com/0-Blu/StikJIT/blob/main/assets/StikJIT.png?raw=true", - "headerURL": "https://github.com/0-Blu/StikJIT/blob/main/assets/StikJIT.png?raw=true", + "iconURL": "https://github.com/StephenDev0/StikJIT/blob/main/assets/StikJIT.png?raw=true", + "headerURL": "https://github.com/StephenDev0/StikJIT/blob/main/assets/StikJIT.png?raw=true", "apps": [ { "name": "StikJIT", @@ -14,16 +15,16 @@ "subtitle": "An on-device JIT enabler for iOS versions 17.4+ (excluding iOS 18.4 beta 1), powered by idevice.", "version": "1.3.2", "versionDate": "2025-04-17", - "versionDescription": "What's Changed\r\n* Add check if 17.4+ is installed by @C4ndyF1sh in https://github.com/0-Blu/StikJIT/pull/128\r\n* Actually fix the -17 error by @0-Blu \r \nFull Changelog: https://github.com/0-Blu/StikJIT/compare/1.3.1...1.3.2", - "downloadURL": "https://github.com/0-Blu/StikJIT/releases/download/1.3.2/StikJIT_1.3.2.ipa", + "versionDescription": "What's Changed\r\n* Add check if 17.4+ is installed by @C4ndyF1sh in https://github.com/StephenDev0/StikJIT/pull/128\r\n* Actually fix the -17 error by @StephenDev0 \r \nFull Changelog: https://github.com/StephenDev0/StikJIT/compare/1.3.1...1.3.2", + "downloadURL": "https://github.com/StephenDev0/StikJIT/releases/download/1.3.2/StikJIT_1.3.2.ipa", "localizedDescription": "Enable JIT capabilities for your sideloaded apps.", - "iconURL": "https://github.com/0-Blu/StikJIT/blob/main/assets/StikJIT.png?raw=true", + "iconURL": "https://github.com/StephenDev0/StikJIT/blob/main/assets/StikJIT.png?raw=true", "tintColor": "#293B45", "size": 6211946, "screenshotURLs": [ - "https://github.com/0-Blu/StikJIT/blob/main/assets/views/dark/HomeScreen.PNG?raw=true", - "https://github.com/0-Blu/StikJIT/blob/main/assets/views/dark/AppsList.PNG?raw=true", - "https://github.com/0-Blu/StikJIT/blob/main/assets/views/dark/Settings.PNG?raw=true" + "https://github.com/StephenDev0/StikJIT/blob/main/assets/views/dark/HomeScreen.PNG?raw=true", + "https://github.com/StephenDev0/StikJIT/blob/main/assets/views/dark/AppsList.PNG?raw=true", + "https://github.com/StephenDev0/StikJIT/blob/main/assets/views/dark/Settings.PNG?raw=true" ], "appPermissions": { "entitlements": [], @@ -33,8 +34,8 @@ { "version": "1.3.2", "date": "2025-04-17", - "localizedDescription": "What's Changed\r\n* Add check if 17.4+ is installed by @C4ndyF1sh in https://github.com/0-Blu/StikJIT/pull/128\r\n* Actually fix the -17 error by @0-Blu \r \nFull Changelog: https://github.com/0-Blu/StikJIT/compare/1.3.1...1.3.2", - "downloadURL": "https://github.com/0-Blu/StikJIT/releases/download/1.3.2/StikJIT_1.3.2.ipa", + "localizedDescription": "What's Changed\r\n* Add check if 17.4+ is installed by @C4ndyF1sh in https://github.com/StephenDev0/StikJIT/pull/128\r\n* Actually fix the -17 error by @StephenDev0 \r \nFull Changelog: https://github.com/StephenDev0/StikJIT/compare/1.3.1...1.3.2", + "downloadURL": "https://github.com/StephenDev0/StikJIT/releases/download/1.3.2/StikJIT_1.3.2.ipa", "size": 6211946, "minOSVersion": "17.4" }, @@ -87,11 +88,11 @@ "caption": "Update of StikJIT just got released!", "date": "2025-04-17T05:06:07Z", "identifier": "release-1.3.2", - "imageURL": "https://github.com/0-Blu/StikJIT/blob/main/assets/StikJIT.png?raw=true", + "imageURL": "https://github.com/StephenDev0/StikJIT/blob/main/assets/StikJIT.png?raw=true", "notify": true, "tintColor": "#293B45", "title": "1.3.2 - StikJIT 17/04/25", - "url": "https://github.com/0-Blu/StikJIT/releases/tag/1.3.2" + "url": "https://github.com/StephenDev0/StikJIT/releases/tag/1.3.2" } ] -} \ No newline at end of file +} diff --git a/user-manual.md b/user-manual.md index 2e9b426a..96fa97fb 100644 --- a/user-manual.md +++ b/user-manual.md @@ -1,14 +1,81 @@ +# How to Install StikJIT (or StikDebug) + +This document outlines the installation process for StikJIT, both with and without SideStore, along with usage instructions, troubleshooting tips, and frequently asked questions. + +## StikJIT installation with SideStore or AltStore Classic + +1. **Install SideStore or AltStore Classic:** + Visit the [SideStore](https://sidestore.io/#get-started) or [AltStore Classic](https://altstore.io) website and follow the provided installation instructions. + +2. **Install StosVPN:** + It is recommended to install [StosVPN](https://apps.apple.com/us/app/stosvpn/id6744003051). + +4. **Obtain StikJIT:** + Add the source for [SideStore](https://tinyurl.com/SideStoreStikJIT) or [AltStore](https://tinyurl.com/AltstoreStikJIT). + +5. **Install via SideStore or AltStore Classic:** + Use SideStore or AltStore to install StikJIT. + +6. **Installation procedures:** + Follow the standard installation procedures in the usage guide below. + +## StikDebug installation with App Store (US) + +1. **Install StikDebug:** + Install StikDebug from the App Store [here](https://apps.apple.com/us/app/stikdebug/id6744045754) + +2. **Installation procedures:** + Follow the standard installation procedures in the usage guide below or from the official guide [here](https://github.com/StephenDev0/StikDebug-Guide/blob/main/pairing_file.md). + +## StikDebug installation with AltStore PAL (EU only) + +1. **Install StikDebug:** + Install StikDebug from AltStore PAL [here](https://tinyurl.com/AltstorePALStikJIT). + +2. **Installation procedures:** + Follow the standard installation procedures in the usage guide below. + +4. **Install AltStore Classic:** + Next, install AltStore Classic via AltStore PAL. AltStore Classic will automatically detect that StikDebug is installed. + +5. **Enabling JIT:** + In AltStore Classic, press and hold the desired app, then select the "Enable JIT" option to activate the feature. + +## StikJIT installation without SideStore or AltStore + +If you prefer not to or cannot use the App Store, SideStore, or AltStore, alternative methods such as Sideloadly are available. + +1. **Install StosVPN:** + Get the latest version of [StosVPN](https://apps.apple.com/us/app/stosvpn/id6744003051) from the App Store. + +2. **Download the StikJIT IPA:** + Obtain the latest StikJIT IPA from [StikJIT](https://github.com/StephenDev0/StikJIT/releases/latest). + +3. **Install via alternative method:** + Install the downloaded IPA through your preferred method. + +4. **Installation procedures:** + Follow the standard installation procedures in the usage guide below. + +--- + +# Post-install Usage Guide + ## Pairing Instructions ### Downloads -Downloads for Jitterbug Pair can be found [here.](https://github.com/osy/Jitterbug/releases/tag/v1.3.1) +- **Windows**: [jitterbugpair-win64.zip](https://github.com/osy/Jitterbug/releases/download/v1.3.1/jitterbugpair-win64.zip) +- **macOS**: [jitterbugpair](https://github.com/osy/Jitterbug/releases/download/v1.3.1/jitterbugpair-macos.zip) +- **Linux**: [jitterbugpair-linux.zip](https://github.com/osy/Jitterbug/releases/download/v1.3.1/jitterbugpair-linux.zip) --- +> [!TIP] +> When using cloud storage, the file extension might change (usually to .txt). It is always recommended to zip your pairing file before transferring it. StikJIT only accepts `.mobiledevicepairing` or `.plist` files. ### For Windows -1. **Extract** `Jitterbugpair-win64.zip`. -2. **Set a passcode** for your device if you haven't already. Unlock your device, connect it to your computer via cable. If a prompt appears: tap "Trust." +1. **Extract** `jitterbugpair-win64.zip`. +2. **Set a passcode** for your device if you haven't already. Unlock your device and connect it to your computer via cable. When a prompt appears, tap "Trust." 3. Open your device to the homescreen. 4. In File Explorer, locate `jitterbugpair.exe` and run it by double-clicking or right-clicking and selecting "Open". 5. JitterbugPair will generate a **pairing file** in the same folder. This file will have the extension `.mobiledevicepairing`. @@ -18,22 +85,39 @@ Downloads for Jitterbug Pair can be found [here.](https://github.com/osy/Jitterb ### For macOS -1. **Extract** `Jitterbugpair-macos.zip`. -2. **Set a passcode** for your device if you haven't already. Unlock your device, connect it to your computer via cable. If a prompt appears: tap "Trust." +1. **Extract** `jitterbugpair-macos.zip` (if applicable). +2. **Set a passcode** for your device if you haven't already. Unlock your device and connect it to your computer via cable. When a prompt appears, tap "Trust." 3. Open your device to the homescreen. -4. Execute `JitterBugPair` by double-clicking or right-clicking and selecting "Open". -5. JitterBugPair will generate a **pairing file** with the extension `.mobiledevicepairing`. -6. **Transfer the pairing file** to your iOS device using AirDrop, iCloud/One/Google Drive, email, or any other method. For best results, compress the file into a .zip folder first. +4. Find and open the extracted `jitterbugpair` file (it should have a black and green icon) by double-clicking it or right-clicking it and selecting "Open." +5. If you get the message" "macOS cannot verify that this app is free from malware": + - Go to System Settings > Privacy & Security + - Scroll down to the message about the app + - Click "Open Anyway," if the program doesn't run automatically, try manually running it again +6. JitterbugPair will generate a **pairing file** with the extension `.mobiledevicepairing` to your user's home folder. +7. If you can't find the pairing file: + - Copy the name of the pairing file generated + - Paste it into Finder + - If you ran the program more than once, all pairing files for your device should appear since they share the same name +8. **Transfer the pairing file** to your iOS device using AirDrop, iCloud/One/Google Drive, email, or any other method. For best results, compress the file into a .zip folder first. --- -### On your iOS device - -1. In the **Files app**, long-press your zipped pairing file and select **Uncompress**. -2. Launch the **StikJIT or StikDebug** app. - - If the app doesn’t appear, restart your device. -3. When prompted, import the **unzipped pairing file**. -4. StikJIT or StikDebug will now be **paired** with your computer. +### For Linux + +1. **Extract** `jitterbugpair-linux.zip`. +2. Open a terminal in the extracted directory. +3. Make the program executable: + ```bash + chmod +x ./jitterbugpair + ``` +4. **Set a passcode** for your device if you haven't already. Unlock your device, connect it to your computer via cable. If a prompt appears: tap "Trust." +5. Open your device to the homescreen. +6. Execute the program: + ```bash + ./jitterbugpair + ``` +7. JitterBugPair will generate a **pairing file** with the extension `.mobiledevicepairing`. +8. **Transfer the pairing file** to your iOS device using your preferred method. For best results, compress the file into a .zip folder first. --- @@ -42,88 +126,59 @@ Downloads for Jitterbug Pair can be found [here.](https://github.com/osy/Jitterb - If you **update or reset your iDevice**, the pairing file will become **invalid**, and you’ll need to repeat the pairing process. - To prompt StikJIT to ask for the pairing file again, go to **StikJIT > Settings** and tap **Import New Pairing File**. -# How to Install StikJIT - -This document outlines the installation process for StikJIT, both with and without SideStore, along with usage instructions, troubleshooting tips, and frequently asked questions. - -## Installation with SideStore or AltStore Classic - -1. **Install SideStore of AltStore:** - Visit the [SideStore](https://sidestore.io/#get-started) or [AltStore](https://altstore.io) website and follow the provided installation instructions. - -2. **Install StosVPN:** - It is recommended to install [StosVPN](https://apps.apple.com/us/app/stosvpn/id6744003051). -3. **Obtain the StikJIT IPA:** - Download the StikJIT IPA from [StikJIT](https://github.com/0-Blu/StikJIT/releases/latest). - -4. **Install via SideStore:** - Use SideStore or AltStore to install the downloaded IPA. Once the installation is complete, the process is finished. - -## Installation with AltStore PAL (EU Only) - -1. **Install StikDebug:** - Download StikDebug from AltStore PAL and follow the standard installation procedures. - -2. **Install AltStore Classic:** - Next, install AltStore Classic via AltStore PAL. AltStore Classic will automatically detect that StikDebug is installed. - -3. **Enable JIT:** - In AltStore Classic, press and hold the desired app, then select the "Enable JIT" option to activate the feature. - -## Installation without SideStore or AltStore - -If you prefer not to use SideStore, alternative methods such as Sideloadly or AltStore are available. - -1. **Download the StikJIT IPA:** - Obtain the IPA from [StikJIT](https://github.com/0-Blu/StikJIT/releases/latest). +--- -2. **Download StosVPN:** - Get the latest version of [StosVPN](https://apps.apple.com/us/app/stosvpn/id6744003051) from the AppStore. +## Standard installation procedures: -3. **Create a Pairing File:** - Follow the instructions in the Pairing Guide section to generate a pairing file. Afterward, compress (zip) the pairing file. +1. **Pair your device:** + Follow the instructions in the pairing guide section above to generate a pairing file. In the **Files app** on your iOS/iPadOS device:, locate your newly-generated pairing file. (If zipped, long-press your zipped pairing file and select **Uncompress**.) + +2. **Enable VPN:** + Activate StosVPN if using StikJIT. -4. **Transfer the Pairing File:** - Share the zipped pairing file with your device. It is recommended to email the file to yourself or upload it to a cloud service such as Google Drive or Proton Drive. +3. **Open the app:** + Launch the **StikJIT** app. If it doesn't appear, restart your device. -## How to Use StikJIT +4. **Import your pairing file:** + Upon launching the app, tap **Import Pairing File**, then navigate to and select your **unzipped pairing file**. -1. **Enable StosVPN:** - Start by activating StosVPN. +## To enable JIT (Every time): -2. **Upload the Pairing File:** - Open the StikJIT application and upload the pairing file obtained via Jitterbugpair. +1. **Enable VPN:** + Start by activating StosVPN for StikJIT or the built-in VPN in StikDebug. If Wi-Fi is avaliable, leave it on, otherwise disable Wi-Fi and mobile data (Airplane Mode). + +2. **Activate JIT:** + Click the “Enable JIT” button and select an app from the list to activate the JIT functionality. -3. **Activate JIT:** - Click the “Enable JIT” button and select an app from the list to activate the JIT functionality. +--- -## Common Issues and Solutions +# Common Issues and Solutions -### Pairing File Issue -9 +## Pairing File Issue -9 - **Issue:** This error may occur if the pairing file has been modified or if a new pairing file was created. - **Solution:** - Generate a new pairing file using JitterBugPair and retry the process. + Generate a new pairing file using JitterbugPair and retry the process. -### Keeping the IPA Up-to-Date +## Keeping the IPA Up-to-Date -- **Issue:** StikJIT is frequently updated with bug fixes. +- **Issue:** StikJIT/StikDebug is frequently updated with bug fixes. - **Recommendation:** - Reinstall the latest IPA every 1–2 days to ensure optimal performance. + Check for updates in your installation store method or reinstall the latest IPA (if applicable) every 1–2 days to ensure optimal performance. ## Frequently Asked Questions - **Does this work with LiveContainer?** - Yes, it functions in the same manner. + Yes, it can be used both standalone or inside LiveContianer. - **Do I need to be connected to Wi-Fi?** -The first launch requires Wi-Fi to mount the ddi. After this you can use Wi-Fi or Airplane mode. +The first launch requires Wi-Fi to mount the DDI. After that you can use Wi-Fi or Airplane Mode. - **Can this be used with a certificate?** Yes, it has to be used with a developer certificate. Distribution and enterprise certificates will **NOT** work. - **Is this open source?** - Yes, the source code is available on [GitHub](https://github.com/0-Blu/StikJIT). + Yes, the source code is available on [GitHub](https://github.com/StephenDev0/StikJIT). - **What iOS versions are supported?** Supported versions range from iOS 17.4 to iOS 18.5 Developer Beta 2 (latest version). @@ -134,13 +189,10 @@ The first launch requires Wi-Fi to mount the ddi. After this you can use Wi-Fi o - **Does iOS 18.4 beta 1 work?** No, Apple broke JIT in this version. You should update. -- **Will StikDebug be available on the normal App Store?** - Maybe, it is unclear if Apple will allow it. - - **Is WireGuard still an option, or is StosVPN required?** -StosVPN is required for StikJIT to work properly. It is not needed for StikDebug because the vpn is built in. +StosVPN is required for StikJIT to work properly. It is not needed for StikDebug because the VPN is built in. -# Idevice Error Codes +# iDevice Error Codes ## Main Library Errors - `Socket` (-1)