Base Credits to LGLTeam ||

WARNING: THIS TEMPLATE IS NOT FOR NEWBIES, THIS IS FOR EXPERIENCES PROGRAMMERS ONLY. NEWBIES SHOULD NOT PROCEED TO TRY IT

This won't cover how to mod games in general, hooking functions, etc that every other online tutorial already covers. This template simply tells you how to use them

For Android mobile users who don't have a PC, please read README-MOBILE.md

MY WEBSITE HERE(https://muskmods.club)

• Prerequisites
• What you need
• Download/clone
• Video Tutorial
• Setting up
• Files to work with and making changes
• Implementing the menu to the target game
• Loading lib without mod menu
• Leeching concerns
• FAQ
• Reporting issues/Cоntact
• Credits/Acknowledgements

Floating mod menu for il2cpp and other native android games, originally based on VanHoevenTRs, and some codes used from Octowolve. KittyMemory, MSHook, And64InlineHook and AY Obfuscator included. Assets are stored as base64 in cpp and does not need to be stored under assets folder.

Support Android 4.4.x up to Android S Preview. ARMv7, x86 and ARM64 architecture supported. However x86 is deprecated for Unity games so x86 is not our priority

Preview:

Before we can jump head first into working a template, we need to go over a few things.

• AN EXPERIENCED MODDER, NOT A BEGINNER: You should be able to mod any games in general, like modifying .so files, dll files, smali files, etc.
• Basic knowledge of smali dalvik opcodes to modify smali
• Basic knowledge ARM and ARM64 assembly, to be able to patch hex (No need x86)
• Basic knowledge of C++ and java (JNI is optional)
• Be able to write hook function in C++ (Not really needed, but recommended if you want to do advanced modding in the future)
• Basic awareness of how Android layout works in XML and Java. This project only use Java for layout but you will learn it easly
• Time and patience: Don't start working on this if you have deadlines or important work. Take your time to read, learn and get used to work with this project.
• DIY (Do it yourself): Yes, you must be able to do things yourself, not depending being spoonfeed. We are not the teachers.
• An inquisitive mind

• Android Studio 4 and up: https://developer.android.com/studio
• NDK Installed via Android Studio (Cmake is not needed) https://developer.android.com/studio/projects/install-ndk#default-version
• Apktool: Apktool.jar or any 3rd party tools
• APK Easy Tool. To get main activity:
• Any text editor. We use Notepad++
• Any png compression to compress your png file: We use https://compresspng.com/
• Any base64 encoding to encode your file: We use https://www.base64encode.org/
• ARM converter, to convert ARM instruction to hex: https://armconverter.com/

Download this repo as ZIP, or clone using any git tools

Or download Releases here https://github.com/springmusk026/Android-Mod-Menu-Kotlin/releases

Extract the source to your desired location. The location must NOT contain any spaces or symbols

Big thanks to modders who created a video tutorial for me. Be warned, those videos might be outdated

PMT DVA: https://www.youtube.com/watch?v=ieMclBtL6Ig

Pasha Production: https://www.youtube.com/watch?v=RvrZKIe-QGc

Make sure you have everything you need to prepare to work.

Extract the project to the location WITHOUT spaces and weird symbols. Spaces and symbols can cause problems

Open the project

Please wait for a while, it will index and sync the project for the first time, takes around a minute depending your computer performance

After it's done, you can start working!

To save and clear logcat on menu settings without root and without file permission. Can be helpful for modders to diagnose the issues

Android 11: /storage/emulated/0/Documents/Mod Menu logs/

Android 10 and below: /storage/emulated/0/Android/data/(package name)/files/Mod Menu logs

Saving the menu feature preferences and calling changes via JNI

Main codes of floating mod menu design

You don't need to change unless you want to redesign it. The codes are explained in the comments

• GradientDrawable: A code for setting corner and stroke/inner border. Works for any View Components

        GradientDrawable gdMenuBody = GradientDrawable()
        gdMenuBody.cornerRadius = MENU_CORNER
        gdMenuBody.setColor(MENU_BG_COLOR)
        gdMenuBody.setStroke(1, Color.parseColor("#32cb00"))

Set the gradient drawable to the view component

[name of your view component].setBackground(gradientdrawable);

• Resizing menu box

I've added variables so you can find it easly to resize

        var MENU_WIDTH = 290
        var MENU_HEIGHT = 210

Note: You may need to implement auto sizing due to many types of phone with different DPIs and resolutions

• Color Animation: The codes can be seen in startAnimation()

• Adding new view

Normally the Android development documentation does not explain the code in java. If you read the Android development documentation and you see an example like TextView

TextView textView = (TextView) findViewById(R.id.textView);
textView.setFontVariationSettings("'wdth' 150");

This is for xml. Instead, create an instance for java and add view to your Layout

        TextView heading = TextView(this)
        heading.ellipsize = TextUtils.TruncateAt.MARQUEE
        heading.marqueeRepeatLimit = -1
        heading.isSingleLine = true
        heading.isSelected = true
        heading.setTextColor(TEXT_COLOR)
        heading.textSize = 10.0f
        heading.gravity = Gravity.CENTER
        heading.setPadding(0, 0, 0, 5)

While we can't explain much here, you can use Google. Search like create a textview programmatically android, create a button programmatically android etc. for more infomation

The Main Activity. Checks if device running Android 6.0 or above and if have overlay permission enabled before starting menu service.

You pretty don't need to work with it unless you are implementing something like login layout.

Menu related with JNI calls

• Title: Big text

• Heading: Little text. Semi HTML is supported. Text will scroll if the text is too long

• Icon: Compressed image that is encoded to base64

You can pretty much use any tools for base64 encoding.

We use a simple website https://www.base64encode.org/

Scroll down till you see Encode files into Base64 format. Click or tap on the box to select a file

Click on ENCODE button and click on CLICK OR TAP HERE to download your encoded file. Now you can paste it in cpp code

• IconWebViewData: Use icon in Web view with GIF animation support. URL requires internet permission android.permission.INTERNET

Examples

//From internet: (Requires android.permission.INTERNET)
return env->NewStringUTF("https://i.imgur.com/SujJ85j.gif"); 

//From assets folder: (Requires android.permission.INTERNET)
return env->NewStringUTF("file:///android_asset/example.gif"); 

//Base64 html:
return env->NewStringUTF("data:image/png;base64, <encoded base64 here>");

//Nothing:
return NULL

• settingsList: Feature list for settings

In this file, you will work with your mods. Below hack_thread, you write your code to patch with KittyMemory or hook with MShook. You must have learned it already

It has a macro to detect if the ARM architecture is 32-bit or 64-bit on compile-time, it's to avoid using wrong offsets, like using ARMv7 offsets on an ARM64 lib. Check the game's APK what libs it contains before you proceed. If you want to target armeabi-v7a lib, write the code below #else. If you want to target arm64-v8a libs, write the code below #if defined(__aarch64__). If the game has both armeabi-v7a and arm64-v8a, save your time and delete arm64-v8a folder, only target on armv7. Don't worry, the game will still work on ARM64

We know we could do #if defined(__arm__) for ARMv7 and #if defined(__i386__) for x86, but we will leaving #else, so AS doesn't make that part greyed out. We will still using ARMv7 as a primary target

• Changes: Get values to apply mods. BE CAREFUL NOT TO ACCIDENTLY REMOVE break;

• settingsList: Settings assigned in negative numbers, we keep the positive numbers for mods. Works same as mod features but the call must be implemented in localChanges(int featureNum, boolean toggle) in FloatingModMenuService.java

• getFeatureList: Mod features

Assigning feature numbers is optional. Without it, it will automatically count for you, starting from 0

Assigned feature numbers can be like any numbers 1,3,200,10... instead in order 0,1,2,3,4,5...

Do not change or translate the first text unless you know what you are doing

Toggle, ButtonOnOff and Checkbox can be switched on by default, if you add True_. Example: CheckBox_True_The Check Box

To learn HTML, go to this page: https://www.w3schools.com/

Usage:

(Optional feature number)_Toggle_(feature name)
(Optional feature number)_True_Toggle_(feature name)
(Optional feature number)_SeekBar_(feature name)_(min value)_(max value)
(Optional feature number)_Spinner_(feature name)_(Items e.g. item1,item2,item3)
(Optional feature number)_Button_(feature name)
(Optional feature number)_ButtonOnOff_(feature name)
(Optional feature number)_InputValue_(feature name)
(Optional feature number)_CheckBox_(feature name)
(Optional feature number)_RadioButton_(feature name)_(Items e.g. radio1,radio2,radio3)
RichTextView_(Text with limited HTML support)
RichWebView_(Full HTML support)
ButtonLink_(feature name)_(URL/Link here)
Category_(text)

To add a collapse, create a new instance

Collapse_The collapse 1

Then you can add component views to collapse like

CollapseAdd_Toggle_The toggle
123_CollapseAdd_Toggle_The toggle
CollapseAdd_Button_The button

MemoryPatch::createWithHex([Lib Name], [offset], "[hex. With or without spaces]");
[Struct].get_CurrBytes().Modify();
[Struct].get_CurrBytes().Restore();

[Struct].get_TargetAddress();
[Struct].get_PatchSize();
[Struct].get_CurrBytes().c_str();

Example: https://github.com/MJx0/KittyMemory/blob/master/Android/test/src/main.cpp

Use ARM Converter to convert ARM to HEX: https://armconverter.com/

ARM64:

A64HookFunction((void *) getAbsoluteAddress([Lib Name], [offset]), (void *)[function], (void **)&[old function]);

ARMv7/x86:

MSHookFunction((void *) getAbsoluteAddress([Lib Name], [offset]), (void *)[function], (void **)&[old function]);

The make file for the c++ compiler. In that file, you can change the lib name on the LOCAL_MODULE line When you change the lib name, change also on System.loadLibrary("") under OnCreate method on MainActivity.java Both must have same name

Connect your device to the computer or run your emulator. Android Studio will detect and you can click Play to run your app.

On physical device, make sure you have USB-Debugging enabled in the developer option of your device. To make it visible, go to Settings > About phone and tap Build number seven times. Return to the previous screen to find Developer options at the bottom. The Developer options screen might be located or named differently on some devices

Sometimes Android Studio does not detect emulators such as NOX or MEMU fail to connect to adb automatically, reboot can help sometimes. Please refer to the support page.

Now we are looking for main activity, there are 2 ways to do

1. Decompile the game's APK file. Open AndroidManifest.xml and search after <action android:name="android.intent.action.MAIN"/>.

Example the game's main activity was com.unity3d.player.UnityPlayerActivity

Be sure to enable Word wrap so it is easier to read

2. APK Easy Tool since it can read out location of main activity without decompiling APK

Note it somewhere to remember it

Decompile the game APK

Open the game's AndroidManifest.xml

Add the SYSTEM_ALERT_WINDOW permission besides other permissions if it doesn't exist. Doesn't matter where you place it as long as it's above the application tag

<uses-permission android:name="android.permission.SYSTEM_ALERT_WINDOW"/>

If you don't add it, you can't allow overlay permission.

Add the service above the end of application tag (change the package name of your menu if you had changed it)

<service android:name="uk.lgl.modmenu.FloatingModMenuService" android:enabled="true" android:exported="false" android:stopWithTask="true"/>

Now we need to call your mod menu activity

There are 2 ways to call your mod menu activity. Choose one of them you like to try. Don't know? just choose METHOD 1

METHOD 1

This simple way, we will call to MainActivity.java. MainActivity.java will never be used

Locate to the game's path of main activity and open the smali file. If the game have multi dexes, it may be located in smali_classes2.. please check all

With the path of the target game’s main activity which we determined earlier com.unity3d.player.UnityPlayerActivity. Think of it like a path /com/unity3d/player/UnityPlayerActivity.smali

Open the main acitivity's smali file, search for OnCreate method and paste this code inside (change the package name if you had changed it)

invoke-static {p0}, Luk/lgl/MainActivity;->Start(Landroid/content/Context;)V

Save the file

METHOD 2

You can follow this it if the first method really fails, or if you really want to use MainActivity.java for a reason. Since this involve changing activites, it may cause some problems.

On your MainActivity.java, put the game's main activity to public String GameActivity

Uncomment this code

Toast.makeText(MainActivity.this, "Error. Game's main activity does not exist", Toast.LENGTH_LONG).show();

On AndroidManifest.xml, remove <action android:name="android.intent.action.MAIN"/> from the game's activity, like this:

If you don't remove <action android:name="android.intent.action.MAIN"/> from the game's activity, your menu will not launch. AndroidManifest.xml can ONLY contain one <action android:name="android.intent.action.MAIN"/>

near the end of application tag </application>, add your main activity above it. uk.lgl.MainActivity is your main activity

<activity android:configChanges="keyboardHidden|orientation|screenSize" android:name="uk.lgl.MainActivity">
     <intent-filter>
         <action android:name="android.intent.action.MAIN"/>
         <category android:name="android.intent.category.LAUNCHER"/>
     </intent-filter>
</activity>

Save the file

Do NOT use both methods at the same time

Build the project to the APK file. Build -> Build Bundle(s)/APK(s) -> Build APK(s)

If no errors occured, you did everything right and build will succeded. You will be notified that it build successfully

Click on locate to show you the location of build.apk. It is stored at (your-project)\app\build\outputs\apk\app-debug.apk

Decompile your app-debug.apk.

Copy your mod menu from decompiled app-debug.apk smali to the game's smali folder. Example ours is uk.lgl.modmenu, we copy the uk folder from app-debug (app-debug\smali\uk) to the game's decompiled directory (game name)\smali

If the game have multidexes, just add your smali to the last smali_classes if possible to prevent compilation errors such as Unsigned short value out of range: xxxxx (Smali limit error)

Copy the library file (.so) from app-debug.apk to the target game. Watch out the folder names, we don't want to mix them up, so make sure to copy our lib file to the correct architecture. Like our armeabi-v7a lib goes to the target games armeabi-v7a folder, arm64-v8a lib goes to the arm64-v8a folder...

PUTTING THE LIB FILE ON A WRONG ARCHITECTURE LIKE PUTTING ARM64 LIB TO ARMV7 WILL RESULT A CRASH!

Now compile and sign the apk, and install it on your device

Congrats. You have successfully implemented a mod menu.

Compile failed? read the log and look up on Google

If you face any problem, please read the FAQ

Leeching as known as stealing code and offsets via reverse enginnering, and editing credits via file editing and recompiling. We all know that, right?

There are some simple protections in the template:

• Simple C++ string obfuscation called AY Obfuscator. Usage OBFUSCATE("string here") and with a key OBFUSCATE_KEY("string here", 64-bit key here). Example OBFUSCATE_KEY("Hello", 2353474243) or in hex OBFUSCATE_KEY("Hello", 0x3FE63DF21A3B). The key must not be too long or too short
• string2Offset("") to protect offsets
• Simple anti-leech measures that crashes if JNI functions are not called
• Quite harder to edit credits via smali
• Toast hidden inside getFeatureList in Main.cpp

These protection are NOT full protection, it does not stop them, it will only slow them down, this intent is to help you improve on your own by yourself. You should:

• Improve anti-leech measures on your own way
• Protect and encrypt your dex and lib. Find the tools or the projects by yourself, chinese based tools is not recommended as anti virus may flag your mod for malware (false positive). Don't tell anyone what protection you are using, don't let game developers get a hand of it
• Improve string obfuscators a lot more or use others which are not known. Make sure that obfuscator is not too simple
• Enable proguard, and add filters to make sure it does not break your project. See https://developer.android.com/studio/build/shrink-code
• Never share your project to someone
• Do not include any important stuff such as 'offline' username and password, instead add an additional layer, e.g. a web service handling the protected request
• And etc.

Never contact how to protect more, never complain that your mod has been leeched, that's all your responsibility! If you are really worry about leeching, or getting constantly leeched, and can't protect, just upload your project on Github. They will download from your Github instead leeching.

Never tell us how to leech stuff, we are not interested getting involved in it, You will get blocked immediately!

There are many many reasons why, it could be your code fault, wrong offsets, bad c++ code, bad layout implementations, game protections etc.

This is very hard to diagnose. Check logcat on Android Studio to see the error logs, open Logcat window from below, and select your device, process and filter to Error. Once you do, you can see the errors in logcat

Error on Java side is really easy to spot, if an the error occured natively, a huge CRASH report will be logged but it can be hard to figure out. You would have to dig deeper and figure out yourself. Google it if possible.

If that caused by your hacks, check if your patches and hooks are correct. For hooks, write down the logs such as LOGD("whatever"); like this below:

bool get_BoolExample(void *instance) {
    LOGD("Bool step 1");
    if (instance != NULL && featureHookToggle) {
        LOGD("Bool step 2");
        return true;
    }
    LOGD("Bool step 3");
    return old_get_BoolExample(instance);
}

This can help you what part of your code faced the problem.

If you believe the game has protection, bypass it or drop it!

See more about logcat: https://developer.android.com/studio/debug/am-logcat

Search for the related issues on Google or on Apktool Github page: https://github.com/iBotPeaches/Apktool/issues

The method index can't fit into an unsigned 16-bit value, means you have too many methods in the smali due to the limit 65535. Place your code on other classes, such as smali_classes2 instead. This work for Android 5 (Lollipop) and above only.

See: https://github.com/LGLTeam/Android-Studio-Solutions/wiki/Executing-external-native-build-for-ndkBuild-Android.mk

See: https://github.com/LGLTeam/Android-Studio-Solutions/wiki

Go to the commit page https://github.com/springmusk026/Android-Mod-Menu-Kotlin/commits/master

Also known as: "You're a developer after all — it shouldn't be that hard!"

Since we can't spend my days on it, we have to prioritize the features and fixes that are likely to benefit the larger number of people. Features that is specific to your usage is not going to benefit that many users after all. This is important that you do not expect that anyone can do everything for you. Developing is hard, and even outside of supporting a feature, adding the code can take longer than you think!

With all this being said, remember that this is 100% Open Source. So if you really want a specific feature, try to do it yourself, or ask someone who are willing to help you.

Anything else, such as how to hook, how to patch, how to bypass, what functions to mod, how il2cpp works, etc. is out of scope. We will not cover anything and trivial stuff every other tutorial online already covers. Instead, try to find a couple of tutorials to learn and mod the game yourself. It's a lot easier than you think. If you can't, find a couple of forums where you can ask your questions or ask the right modder for specific special features

There is no ETA, we only push a commit when we want to. Please don't ask the same question over and over again. You could make something better yourself without having to wait

Thanks to the following individuals whose code helped me develop this mod menu

• Octowolve/Escanor - Mod menu: https://github.com/z3r0Sec/Substrate-Template-With-Mod-Menu and Hooking: https://github.com/z3r0Sec/Substrate-Hooking-Example
• VanHoevenTR - Mod menu - https://github.com/LGLTeam/VanHoevenTR_Android_Mod_Menu
• MrIkso - First mod menu template https://github.com/MrIkso/FloatingModMenu
• MJx0 A.K.A Ruit - https://github.com/MJx0/KittyMemory
• Rprop - https://github.com/Rprop/And64InlineHook
• And everyone else who provided input and contributions to this project!