Minecraft Forums

1. Xcode - install from the app store. It is possible to create mods without Xcode. That is how C0deh4cker does it. I personally prefer to have an IDE so this tutorial will use Xcode.
2. iOSBrokenDev - download the repository from github:
Unzip the repository and navigate to that folder in Terminal. (I do that by typing "cd " and then dragging the folder into Terminal.) In Terminal run "sudo ./iOSBrokenDev.sh". You will need to enter your password.

3. MacPorts - I used macports to install dpkg. The installers for macports can be found here choose the one for your correct OS version.
4. dpkg - this is how you will build your package. I used macports to install dpkg. In terminal run "sudo port install dpkg". You will need to enter your password.

1. Open Xcode.
2. Go to File->New->Project...


3. In the sidebar choose iOSBrokenDev and use the StubHook Mod template.


4. Click next, name your mod and turn off Automatic Reference Counting, click next, and save your project.


5. Change the build location. In the menu bar go to File->Project Settings. Choose advanced and then legacy.


6. Add libstubhook.dylib and stubhook.h to your project. In terminal run these commands. They will need your devices password. This is "alpine" (no quotes) unless you have changed it. Your "i-device ip address" can be found by going into Settings->Wi-Fi-><network name>(tap the blue arrow). The device ip address is the first in the list.

scp [email protected]<i-device ip address>:/usr/lib/libstubhook.dylib /path/to/project/folder/libstubhook.dylib
scp [email protected]<i-device ip address>:/usr/include/stubhook.h /path/to/project/folder/stubhook.h


After you run those commands, you will have libstubhook.dylib and stubhook.h in your project folder. Drag them to you project in Xcode.

1. Put in addresses. You will need the addresses of the functions you want to hook or use. There are a few in C0deh4cker's mods on Github and TreeBl posted a list of them. You will probably want to find your own. That might be for another tutorial. You will notice the errors Xcode is giving me. That is because I haven't actually defined the Level$$explode function. I will do that in the next step.


2. In order to make the mod actually do something I will need to hook the Level$$explode function. That means that my mod says what the function does instead of the original one. Hooking the function also defines it which gets rid of the two errors in the last step.


3. Now that the function has a hook, I need to apply the hook in the constructor.

1. In the menu bar, go to Product->Build.


2. Make sure that the dylib in the Products in the sidebar turns from red to black. If not, make sure you are building for iOS device.

1. In your project folder create a folder called <yourcompanyidentifier>.<yourmodname>. For my mod that will be called com.zcodemt.bigtnt. In that folder create the folder structure in the picture.


2. You will notice the file called control in the DEBIAN folder. Create that file and paste this in it. You will need to make sure it has no extension; the full name of that files is control.

Package: <yourcompanyidentifier>.<yourmodname>
Name: <yourmodname>
Version: <mod-version>
Description: <mod-description>
Section: Minecraft
Depends: mobilesubstrate, libstubhook
Architecture: iphoneos-arm
Author: <you>
Maintainer: <you>



3. Edit the control file to fit your mod. The only thing you shouldn't change is the Depends line.
4. In your project folder open build/Debug-iphoneos copy the dylib file from there to the DynamicLibraries folder.


5. Create a new file in textedit and save it with the same name as the dylib but with the extension plist. Paste this in the file:

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "" rel="noopener nofollow" target="_blank">http://www.apple.com/DTDs/PropertyList-1.0.dtd&quot;&gt;
<plist version="1.0">
<dict>
<key>Filter</key>
<dict>
<key>Bundles</key>
<array>
<string>com.mojang.minecraftpe</string>
</array>
</dict>
</dict>
</plist>



6. You should now have a file structure similar to this one:


7. In terminal, navigate to your project folder and run "dpkg-deb -b <yourcompanyidentifier>.<yourmodname>"

Quote from Eryhaker598118

Um... What about windows?

Quote from C0deH4cker

NOOOOOO!!!! So much wrong with this topic....

1. DO NOT USE THAT TEMPLATE! That uses libstubhook as if it is a framework. If you try to use that mod on another device, it will not work.
2. You can't show a UIAlertView from SHConstructor because there's no UIWindow yet! That will just make it crash.
3. It is never a good idea to bug the user with an alert, especially EVERY TIME like will happen with this template.
4. You are claiming libstubhook to be your own. I don't care that you for some unknown reason decided to make libstubhook into a framework (which was a very bad idea), but you also have yourself listed as the author of stubhook. I do not tolerate when people steal credit for something I've done, and that's exactly what you are doing. You just wrapped my libstubhook into a framework (did I mention that was a bad idea?) and threw it on your repo for credit and more repo users.


Believe it or not, I have reasons for doing things the way I do them. For example, I made libstubhook be a LIBRARY, not a FRAMEWORK. Frameworks are HUGE projects of code. Libraries are for smaller pieces of code and are both easier to work with than frameworks and more common. Additionally, I put libstubhook on a default repository so mods using it could easily list it as a depend. You go off making people add some obscure repo (yours) and have mod makers list "com.zcodemt.something" (again, taking credit for MY libstubhook), which is a total mess.

Please either completely remove this so-called tutorial and your GitHub repository, or remake the tutorial from scratch (and still delete that GitHub repo). Also, remove stubhook from your repo.

Quote from C0deH4cker

NOOOOOO!!!! So much wrong with this topic....

1. DO NOT USE THAT TEMPLATE! That uses libstubhook as if it is a framework. If you try to use that mod on another device, it will not work.
2. You can't show a UIAlertView from SHConstructor because there's no UIWindow yet! That will just make it crash.
3. It is never a good idea to bug the user with an alert, especially EVERY TIME like will happen with this template.
4. You are claiming libstubhook to be your own. I don't care that you for some unknown reason decided to make libstubhook into a framework (which was a very bad idea), but you also have yourself listed as the author of stubhook. I do not tolerate when people steal credit for something I've done, and that's exactly what you are doing. You just wrapped my libstubhook into a framework (did I mention that was a bad idea?) and threw it on your repo for credit and more repo users.


Believe it or not, I have reasons for doing things the way I do them. For example, I made libstubhook be a LIBRARY, not a FRAMEWORK. Frameworks are HUGE projects of code. Libraries are for smaller pieces of code and are both easier to work with than frameworks and more common. Additionally, I put libstubhook on a default repository so mods using it could easily list it as a depend. You go off making people add some obscure repo (yours) and have mod makers list "com.zcodemt.something" (again, taking credit for MY libstubhook), which is a total mess.

Please either completely remove this so-called tutorial and your GitHub repository, or remake the tutorial from scratch (and still delete that GitHub repo). Also, remove stubhook from your repo.

Quote from ZCodeMT

I understand why you would be angry. I didn't mean it to be the way you are looking at it. Here are my answers:

1. I made a mistake while testing that made me think it worked.
2. I hadn't tested that yet. I guess I should have.
3. How would you suggest making it show only once?
4. I did not claim stubhook as my own. I understand that you put a lot of work in it and if you tell me where I claim it as my work, I will fix that. I put it on the github repository to make it easier for people. Since you obviously dissagree, I removed it from github and will change the tutorial to include instructions for getting it off of an i-device.

I absolutely believe you have reasons for doing things, just like I do. I know from experience that frameworks are a lot easier to work with in Xcode than libraries. After further testing today, I realized that the framework didn't work the way I wanted to.

I am not going to completely rewrite the tutorial from scratch because parts of it have no problems. As for the github repository, that is not just for stubhook, so I won't completely remove it. I removed the stubhook framework stuff and changed the template so that it does not use stubhook as a framework. If you still think it is unacceptable, I will remove it from github and use it for myself only.

Now . . . time to fix that tutorial!

static void show_incompatible(NSString* version) {
    NSUserDefaults* settings = [NSUserDefaults standardUserDefaults];
    NSString* key = [NSString stringWithFormat:@"incompatible_shown_%@", version];
    if(![settings boolForKey:key]) {
        // Show alert popup

        // Set alert shown key
        [settings setBool:YES forKey:key];
        [settings synchronize];
    }
}

Quote from C0deH4cker

2) Also, no Objective-C code at all should be run in SHConstructor unless you wrap it in @autorelease { }. Since there is no autorelease pool allocated when SHConstructor is run, any Objective-C code that either uses autoreleased objects directly or indirectly will create memory leaks, leading to crashes.
3) In my sprinting mod I did this:

static void show_incompatible(NSString* version) {
NSUserDefaults* settings = [NSUserDefaults standardUserDefaults];
NSString* key = [NSString stringWithFormat:@"incompatible_shown_%@", version];
if(![settings boolForKey:key]) {
// Show alert popup

// Set alert shown key
[settings setBool:YES forKey:key];
[settings synchronize];
}
}

If you use this code, DO NOT use the same key as I do.
Please note that a planned feature for libstubhook is to support version incompatibility reports, so your mod will basically just call SHIncompatible("mod name here"), and your mod's name will be displayed in a once-per-version update alert as a list with all other incompatible mods. Sample code will be up when this feature is added.

Thank you for being so quick to fix the issue with stubhook as a framework. I realize you did not intend to take credit for it, but that was the effect.

I don't have a Mac yet and therefore don't know how Xcode projects/templates work, but all you need to do is set the LDFLAGS to '-dynamiclib -lstubhook'.


I plan on making a libstubhook tutorial for iOS myself, so please don't try to do that. It will include a Theos template.

Quote from ZCodeMT

Thanks for understanding what I did and for the tips. I know how to link with a dylib in Xcode, but I don't know how to do it in a template. I will see if I can get that figured out.

Also, could you give a yes or a no on the tutorial. Considering your first post on this topic, no one will use it unless you approve the changes I made.

Quote from C0deH4cker

The tutorial only tells how to setup Xcode to be able to use libstubhook. If that's what you were trying to do, then that's fine. Just reflect that in your title (something like "Using libstubhook from Xcode" would work).

Also, mods shouldnt use ARC. In general, ARC doesn't play well with mods/tweaks.

Plus, mods shouldn't depend on iOS 5+. Just remove that firmware dependency.

If that can all be changed, then I'll agree w/ this tutorial and even edit my posts to remove the initial criticism.

Quote from C0deH4cker

Okay, this tutorial looks good now. One thing i'd like to point out:
SHStub just sets the address of a function. If you want to hook that function, you must first SHHook it and then SHApplyHook in SHConstructor. If you simply want to call that function from your own code, just declare it as a static function pointer and SHStub it.