dragon consists of 2 main components:
- A packaging system
- A ninja buildfile generator
It uses Theos components for logos processing, but does not require an existing theos installation.
pip install dragon
Dragon projects are configured via a single DragonMake file, regardless of how many subprojects you have.
You can specify subprojects and their information here. This allows for compiling slices in parallel easily, along with keeping things much more organized.
DragonMake follows fairly standard YAML syntax, with a singular escape character,
For single line variables, you can use bash syntax to evaluate a command with
$ denotes a ninja variable. For using bash syntax in variables, one can use
$$ to represent a
$ . For example, one could use
$$PWD to get the value of an environment variable in a command.
Using the below items will parse output through xargs and add entries to the list the item is in:
$wildcard("directory", "*.extension") will find all files in a specific directory.
$eval("bash command") is also provided, in the event more complex manipulation is needed.
This should serve as a guideline for how a project should be laid out. You can declare as many projects as you want, it's all going to be crammed into the same deb.
Note: You dont need to create a control file if the relevant info is included in this one.
--- # This represents the overall project name. # Everything in here will be built into a .deb package for installation # Replace TweakName with the name of your project, of course name: TweakName icmd: killall -9 SpringBoard id: com.mycompany.tweakname version: 1.3 author: kritanta depends: mobilesubstrate, preferenceloader TweakName: type: tweak files: - "*.xm" # Now for preferences! TweakNamePrefs: dir: nameprefs type: prefs files: - BlahRootListController.m - ACellYouUse.m - ../SomeFileFromYourMainTweak.m # Subproject example ASubTweakName: dir: othertweak type: tweak files: - Tweak.xm
Please pay attention to the provided example to understand how these should be laid out in a file.
||str||Name of the whole project||N/A|
||str||Command to run on device after install|
||str||Name of the item being build. Specified as
||str||Type of project being built. One of "tweak"/"bundle"/"library".||N/A|
||list||List of files that require the logos preprocessor|||
||list||List of files to be compiled, excluding logos files.|||
||str||Minimum iOS Version Required|||
||list||Architechtures to compile for|||
||str||Root of the Patched SDK to build with||$DRAGONBUILD/sdks/iPhoneOS.sdk|
||str||c/c++ compiler to use||clang+|
||str||linker to use||clang+|
||str||ldid binary to sign with||ldid|
||str||dsymutil binary to symbolicate with||dsymutil|
||str||logos.pl file to use for preprocessing|
||str/list||Console command(s) to run before after build and before packaging|
||str||-fobjc-arc, if enabling so is desired|
||str||Optimzation level. Higher levels can break obfuscators.||0|
||list||List of libraries to link the binary against|
||list||List of Frameworks to compile with||['CoreFoundation', 'Foundation', 'UIKit', 'CoreGraphics', 'QuartzCore', 'CoreImage', 'AudioToolbox']|
||str||additional flags to pass to clang and the linker|
||str||additional flags to pass to the linker|
||str||custom option for ldid||'-S'|
||str||override variable for bundles/libraries to allow specifying install location|
||list||Framework Search Dirs. Changing this variable overrides defaults.||['$sysroot/System/Library/Frameworks', '$sysroot/System/Library/PrivateFrameworks', '$dragondir/frameworks']|
||list||Allows adding framework search dirs without overwriting old ones.|||
||list||Library search dirs. Just like the framework search||['$dragondir/lib', '.']|
||list||Add to lib search without overwriting|||
Yaml parsing is done via python3.
dragon Command Line Arguments
All of these can be combined and ran at the same time, if needed.
All of these arguments can be specified using only the first character (
dragon c b i for example)
dragon v1.3 -=-=- usage: dragon [commands] Building -=-=- do - Build and Install c|clean - clean old build files. b|build|make - build and package your project r|remote - Build using remote server sr|rconf - Setup remote server Installation -=-=- s|device - Set build device IP/Port i|install - Install to build device sim - Install to the simulator instead of a device rs|respring - Respring the current build device dr|devicerun - Run anything after this flag on device sn|send <file> - Install a .deb to the device Tools -=-=- d|debug [Process Name] - Start a debugging server on device and connect to it (Can be used with the install flag as well) exp|export - Tell ninja to create a compile_commands.json f|flutter - Build with flutter before doing anything else ch|checkra1n - Open Checkra1n GUI chc|checkra1ncli - Open Checkra1n CLI Debugging -=-=- vn - Print clang/ld/etc. commands and flags vd - echo every bash command in the main dragon file vg - DragonGen verbositiy. norm - Doesn't delete build.ninja after building. ddebug - Enable all debug flags -=-=-
Generating compile commands for clangd or other tools