Welcome to the iPhoneDevWiki
Our goal is to share the sum of all human knowledge about jailbroken iOS development. In other words, this is a collection of documentation written by developers to help each other write extensions (tweaks) for jailbroken iOS, and you're invited to learn from it and contribute to it too.
What is this wiki for?
- Information about using iOS frameworks (both public and private), SpringBoard, system daemons (for hooking and hacking), and classes in applications included with the system.
- Information about third-party libraries and extensions for developers (ActionMenu, AppList, Flipswitch, IconSupport, libactivator, libhide, libobjcipc, libstatusbar, PreferenceLoader, RocketBootstrap, etc.).
- Lists of Open Source Projects, Reverse Engineering Tools, advice for new developers, development blogs, and other useful information for developers.
- Documentation about making preferences for extensions: PreferenceLoader, PreferenceBundles, Preferences specifier plist, Preferences.framework.
- Anything else about development for jailbroken iOS devices. (For other technical information about iOS, see The iPhone Wiki, which covers topics including jailbreak exploits, internal iOS systems, and iOS hardware details. "Up to Speed" is its getting-started page about learning about security research on iOS.)
Current featured article: Updating extensions for iOS 9
If you'd like to make a new article or improve an existing article, see Help:Editing for advice (and see #Editing this wiki for ideas). Articles that need work: Packaging (tools, control file tips, troubleshooting dpkg-deb errors), Next Steps After Getting Started (a set of ideas for tutorials you could write), edit this page and add your idea here.
New to developing for jailbroken devices? Welcome, it's fun and challenging! Hopefully you already have some experience with Objective-C. You will want to get familiar with Cydia Substrate (formerly called MobileSubstrate) and Theos, and you can study some Open Source Projects to see how existing tweaks work. See Getting Started and also take a look at Best Practices and MobileSubstrate Pitfalls. If you're looking for a more thorough and sequential tutorial, take a look at the book iOS App Reverse Engineering and its forum iOSRE.
How to ask for help: You can ask questions in the IRC channel #iphonedev on irc.saurik.com (where a bunch of developers hang out). IRC is an old-school chat system; if you don't already know how to use it, How to use IRC has details for you. There are also tags for "jailbreak", "Cydia", and "Theos" on Stack Overflow, a site for programming questions in general; feel free to ask there as well. (If you want to help answer questions, following @JailbreakDevQs might be useful.) On reddit, there's /r/jailbreakdevelopers. For non-development-related troubleshooting questions, try JailbreakQA or /r/jailbreak.
Overview of contents
- System directories:
- Other parts of iOS:
- Development tools:
- Other articles about development:
- Getting Started • Best Practices • MobileSubstrate Pitfalls • Open Source Projects • Advice for new developers • Updating extensions for iOS 8 • Updating extensions for iOS 7 • Debugging on iOS 7 • Cydia Store Integration • Tweak DRM • Code Signing • Repository Management • Packaging • Crack prevention • List of development blogs • Using ARC in tweaks • Career advice
By iOS version:
- New in iOS 9: Updating extensions for iOS 9.
- New in iOS 8: Updating extensions for iOS 8, AssertionServices.framework, SBSRestartRenderServerAction, FBSSystemService, UIAlertController.
- New in iOS 7: Updating extensions for iOS 7, Debugging on iOS 7, Downgrading iPhone 4 from iOS 7, BiometricKit.framework, TouchID, UIBackdropView, AVFlashlight, SBAppSliderController.
- New in iOS 6: BackBoardServices.framework, backboardd, ChatKit.framework, BKSProcessAssertion.
- New in iOS 5: SBIconView, CKMadridService, SBAppContextHostManager.
- New in iOS 4: SBAppSwitcherModel.
- Français: Main page/fr • MobileSubstrate/fr • SSH Over USB/fr • UIFont/fr • UIColor/fr • ActorKit.framework/fr • IOSOpenDev/fr
- ไทย: MobileSubstrate/th • SSH Over USB/th • SpringBoard.app/th • UIColor/th
Editing this wiki
- If you have anything at all to contribute, feel free to do so!
- An account is required to edit pages, but everyone is welcome to make an account. If you have trouble with the account creation process, or any questions about editing the wiki, please ask in #iphonedev on irc.saurik.com for help (see How to use IRC).
Some ideas for information to contribute:
- Add more projects to the list of Open Source Projects, or fill out details on that page.
- Expand Getting Started for new developers - what do they need to know before beginning? How do they set up a development environment on OS X, Windows, and Linux? What are common beginner's mistakes that they should watch out for? How to reverse-engineer parts of iOS for writing tweaks? How to debug with GDB and learn about memory management?
- Update articles that haven't been significantly edited in a few years, such as Seatbelt and Crack prevention. See Special:AncientPages for a list of articles that haven't been updated recently.
- Help Cycript explain why Cycript is fun - syntax highlighting, injection, auto-completion, generally exploring around.
- Make a page that documents a class or framework you're familiar with.
- If you've developed a library that other developers can use or write addons/plugins/extensions for, make a page that documents your project.
- Update Xcode with better information about how to build apps for jailbroken devices.
- Make the homepage more useful! For example, add links to good pages that are hidden/buried deep within the wiki.
- The following articles are linked from nowhere in the wiki: Special:LonelyPages - you can fix that by linking them somewhere.
- Check out the most popular pages and see if they need updating: Special:PopularPages.
- Write an article that is in demand: Special:WantedPages.
- Translate an existing article into a non-English language. Check out the list at Special:PopularPages for ideas about high-priority articles to translate, and then make a new page with this name format:
Article name/[language code]. Here's the list of language codes. For example: PreferenceLoader/de or Libactivator/sv.
- We'll make an exception for lawyers; they may submit too. Cf. http://wiki.creativecommons.org/Frequently_Asked_Questions#How_does_a_Creative_Commons_license_operate.3F: "Creative Commons licenses are expressed in three different formats: the Commons Deed (human-readable code), the Legal Code (lawyer-readable code); and the metadata (machine readable code)."