Database Develop

[MOD][TEMPLATE] Magisk Module Template with EvilTheme Patcher

Hello everyone.
This is a little mod to the Magisk Module Template that allows you to patch APK files on-the-fly and have them created as a Magisk Module.
For example, you could have a modified camera module for your ROM, where this patcher would replace the classes.dex file with mods, then pack that as a Magisk Module, using the original file found in the /system (ROM)
For some of the devs that have been around for a while, you would be aware of the old VRTheme modding system, which would allow you to patch files on-the-fly. EvilTheme is basically a newer version of that, so combined with Magisk can be very useful
Here's what this module CAN do:
Replace resources.arsc, classes.dex, AndroidManifest.xml, and META-INF folder
Replace compiled res folders / files
Here's what this module CAN'T do:
Replace files in res/values or smali folders
How to use EVilTheme
(Example using /system/priv-app/SecSettings2.apk)
In the eviltheme folder, go to system and make a folder called priv-app. Inside it, make another folder called SecSettings2.apk
Now make folders as necessary, according to the location of the files you want to theme. For example, battery_icon_50.png is located in res/drawable-hdpi, so make a folder named res inside SecSettings2.apk.
Inside it, create a folder named drawable-hdpi, then paste your new battery_icon_50.png inside.
Repeat step 2 until you've placed your theme files in their appropriate locations.
When you're done, go back to the root folder of the theme (the one that contains eviltheme, engine, etc.) and put all the objects in a ZIP file.
You should use Deflate compression with compression level on Normal, but if your theme is huge, you can safely try compressing using Deflate and the level set to Ultra or whatever high level is available.
Test your mod.
For information regarding the Magisk Module subbmision etc, please read the information HERE
Link to Github Repository: HERE
Enjoy

Nice! Sounds interesting!
I've been using vrtheme for years and even contacted spanna aabout adapting the script to achieve modding of live system files this eliminating the need for recovery zips and even Aroma!
So I have a question about the use and locations of the asset files.
Would it be possible to change, at least the location from which the files get pulled from and placed into the execute folders?
So basically could it be set to pull the image/resource, whatever file from either a data folder or my preference, sd storage?
I've used an asset folder built into my system for similar commands, but with enough options and large files the system partition can get extremely crowded.
Does my question make sense?
Basically i would like to eliminate a big section of my packed 2gb Aroma zip. About 700mb is all vrtheme injected compiled files.
Either way I will definitely be looking into this!
Thanks

stangdriver44 said:
Nice! Sounds interesting!
I've been using vrtheme for years and even contacted spanna aabout adapting the script to achieve modding of live system files this eliminating the need for recovery zips and even Aroma!
So I have a question about the use and locations of the asset files.
Would it be possible to change, at least the location from which the files get pulled from and placed into the execute folders?
So basically could it be set to pull the image/resource, whatever file from either a data folder or my preference, sd storage?
I've used an asset folder built into my system for similar commands, but with enough options and large files the system partition can get extremely crowded.
Does my question make sense?
Basically i would like to eliminate a big section of my packed 2gb Aroma zip. About 700mb is all vrtheme injected compiled files.
Either way I will definitely be looking into this!
Thanks
Click to expand...
Click to collapse
You could, but you would have to look at update-binary and installtheme.sh, then modify it for your needs. So instead of copying the modded files from the flashable zip, you would just have to remove the unzip function and change the path of where they are unzipped to to the location of where the files are on your data partition.
Give it a try

so with this I can technically change the rotation of an app without ever messing with the apk? I've tried editing the AndroidManifest.xml, but after editing I've never been successful putting it back into the apk

dimm0k said:
so with this I can technically change the rotation of an app without ever messing with the apk? I've tried editing the AndroidManifest.xml, but after editing I've never been successful putting it back into the apk
Click to expand...
Click to collapse
If you plan to change androidmanifest.xml you will have to include the newly created META-INF folder for it too.

Could this be used to convert substratum themes to work systemlessly with magisk?
Sent from my Pixel using XDA Labs

qwer777 said:
Could this be used to convert substratum themes to work systemlessly with magisk?
Sent from my Pixel using XDA Labs
Click to expand...
Click to collapse
If you're talking about pre-packaged APK theme files, no it probably won't work, as they still need to be installed.
This is more for files that are already installed that require patching.

Nice work
Got one question - is it possible to modify classes.dex if .apk file is not in system folder? I mean for example, if system app gets updated, it creates new folder in data/app/ with the name of the package and with either -1, -2 or whetever number at the end (ex. data/app/com.google.android.youtube-2).
Do I need to just integrate update into system and then modify it? Or just create new folder in eviltheme one with data/... instead of system/...?
Thanks

I tried to modify system/framework/framework-res.apk/res/drawable-xxhdpi-v4/default_wallpaper.jpg, but unfortunately it did not work. Neither on InFocus M808/mod stock 6.0(mt6753) nor on SamsungS5Neo/mod stock 6.0.1(exynos7580)
Both tried with official Magisk 12.0 and newest beta.

nevermind i didn't read all the way

drei.liter.milch said:
I tried to modify system/framework/framework-res.apk/res/drawable-xxhdpi-v4/default_wallpaper.jpg, but unfortunately it did not work. Neither on InFocus M808/mod stock 6.0(mt6753) nor on SamsungS5Neo/mod stock 6.0.1(exynos7580)
Both tried with official Magisk 12.0 and newest beta.
Click to expand...
Click to collapse
Started another try to replace some icons. did not work. am I missing something or is this template just faulty?
anybody who got this working?

drei.liter.milch said:
Started another try to replace some icons. did not work. am I missing something or is this template just crap?
anybody who got this working?
Click to expand...
Click to collapse
That was a bit rude.
Edit: better to give some details on what you've actually done, maybe even upload your files. Easier to find any faults on your side or possible bugs that way.

I want to add the clock onto my lockscreen statusbar. Would this help me achieve that?

Didgeridoohan said:
That was a bit rude.
Edit: better to give some details on what you've actually done, maybe even upload your files. Easier to find any faults on your side or possible bugs that way.
Click to expand...
Click to collapse
yes ok, the word "crap" maybe was a little bit over the top. i'm sorry for that. I just would like to know, if anybody can report this module/template as working. If so, I would go on looking for the error on my side.
I've actually followed exactly the guide given in OP. (It seems not that tricky to me)
-placed folder tree system/framework/framework-res.apk/res/drawable-xxhdpi-v4/ in the eviltheme-folder and put my default_wallpaper.jpg file in drawable-xxhdpi-v4 folder
-edited module.prop und config.sh
-zipped the whole template folder
-installed via magisk manager
-rebooted
tried with to different phones, beta and official magisk (see my first post)
I'll reproduce my logs and attach them later.
anyway thanks for the hint

drei.liter.milch said:
yes ok, the word "crap" maybe was a little bit over the top. i'm sorry for that. I just would like to know, if anybody can report this module/template as working. If so, I would go on looking for the error on my side.
I've actually followed exactly the guide given in OP. (It seems not that tricky to me)
-placed folder tree system/framework/framework-res.apk/res/drawable-xxhdpi-v4/ in the eviltheme-folder and put my default_wallpaper.jpg file in drawable-xxhdpi-v4 folder
-edited module.prop und config.sh
-zipped the whole template folder
-installed via magisk manager
-rebooted
tried with to different phones, beta and official magisk (see my first post)
I'll reproduce my logs and attach them later.
anyway thanks for the hint
Click to expand...
Click to collapse
Flash Via Recovery, it may work. didnt work for me when i installed from magisk manager.
btw i have a question, is there any way to remove a file from the apk?

shekhawat2 said:
Flash Via Recovery, it may work. didnt work for me when i installed from magisk manager.
btw i have a question, is there any way to remove a file from the apk?
Click to expand...
Click to collapse
thx, i'll try that. which magisk-version do you use? and i guess maybe you can remove a file by placing a dummy.

drei.liter.milch said:
thx, i'll try that. which magisk-version do you use? and i guess maybe you can remove a file by placing a dummy.
Click to expand...
Click to collapse
No brother, I want to delete the file, not to replace it with dummy file. Replacing with dummy file will give system ui FCs.
I saw something delete.list in the installtheme.sh, but I don't know how to use it. If anyone can help, pls help me.
BTW I am using Magisk v12.

shekhawat2 said:
No brother, I want to delete the file, not to replace it with dummy file. Replacing with dummy file will give system ui FCs.
I saw something delete.list in the installtheme.sh, but I don't know how to use it. If anyone can help, pls help me.
BTW I am using Magisk v12.
Click to expand...
Click to collapse
Ok, I see. Perhaps you find sth about it in the vrtheme-topic. Btw. flashing in recovery doesn't work either. I'm not messing around with this anymore and continue using flipster :good:

Where can we download? I want to change Viber's background to pure black so I will change the AndroidManifest. Will this theoretically work?

I was wondering what, if anything, I would need to change for this to work on a pixel. On Pixel's, the install path is system/system. I couldn't tell whether or not this could detect the correct path on its own.
Edit: Never mind. I got it to work.

How to make a Magisk module replace files/folder inside an apk file?

Hi,
So I want to systemlessly replace a huge number of files (images)/or just an entire folder within an app.
For example: inside app.apk there is a folder "assets/images". I want to replace every single image that is in that folder with other ones.
Is this possible with a Magisk Module?

Grab a copy of the apk, edit it to your liking, and then make a Magisk module that replaces the stock apk with your edited one.
That would be the way to do it in Magisk.
If you want it done in a more automatic fashion, you would have to create a script or program that extracts the apk, edits it, and then creates and installs a Magisk module that replaces the stock apk with the edited one.

Yes, I would like an automated one... I think it should be done with post-fs-data.sh. But is it capable of decompiling and recompiling apk files?

No. And you don't want to do something like that during post-fs-data.
Your best bet (IMHO) is to do it during installation of the module, somehow. An automated process that pulls the apk from /system, decompiles, edits, and recompiles it, before installing it as a Magisk module.
Why do you need the automation? Just for fun, or do you specifically need it? I often find my reason for doing something to be: "to see if I can"... :laugh:

Didgeridoohan said:
No. And you don't want to do something like that during post-fs-data.
Your best bet (IMHO) is to do it during installation of the module, somehow. An automated process that pulls the apk from /system, decompiles, edits, and recompiles it, before installing it as a Magisk module.
Why do you need the automation? Just for fun, or do you specifically need it? I often find my reason for doing something to be: "to see if I can"... :laugh:
Click to expand...
Click to collapse
Yes, I want to learn and see if I can do it. And Ivdont want to make a new apk everytime the original app updates. If you have a script this happens automatically.
Also if I program config.sh (this is the install script right?) to automate this process would it still me systemless? I think even when I uninstall the module the mod would still be there...

ilivss said:
Also if I program config.sh (this is the install script right?) to automate this process would it still me systemless? I think even when I uninstall the module the mod would still be there...
Click to expand...
Click to collapse
If you copy the apk from /system before working on it, and then make it into a Magisk module that magic mounts the apk over the stock apk, it'll be a systemless modification. If you then proceed to uninstall the module, the modified apk will not be replacing the original apk anymore, returning everything to stock. Anything else would not be systemless...

Didgeridoohan said:
Why do you need the automation? Just for fun, or do you specifically need it? I often find my reason for doing something to be: "to see if I can"... :laugh:
Click to expand...
Click to collapse
I got one that I actually need. Rotation set to landscape and auto-rotation off in the head unit upgrade I recently put on. However, my unit orientation is portrait.
I have Magisk installed, and I need it to override this setting and change the default to portrait.
Is this even possible or sound like something fun to do ?

Magisk Module development help

This is my first attempt at a Magisk Module (to fix a issue with a few poorly coded legacy apps and not trip safety net) inject or replace a font and set proper permission on the file
My super simple experiment is here (based on the template from Git)
https://drive.google.com/file/d/1PHdRjzefpSMg51KUOffo4FtqlfoxshOM
Magisk gives me a error when I try to install
I probably did something wrong, hopefully someone can point me in the correct direction (error one, not a valid Magisk Module, error two Magisk is not activated)
I appreciate any insight - please move this post to the correct location if needed

If you want someone to look at the module you'll have to enable sharing for the file first...
But, your errors are usually:
1 - the zip has been packaged wrongly (not the proper file/directory structure
2 - using an old template
Take a look in the official docs on how to work with the current module and module installation setup:
https://topjohnwu.github.io/Magisk/guides.html

Let's try this link:
https://drive.google.com/file/d/1PHdRjzefpSMg51KUOffo4FtqlfoxshOM/view?usp=sharing

I started on Git, but I may have inadvertently been in the wrong place / pulled the wrong file -- I will go back through that link you provided tomorrow and see if something jumps out at me

Yeah, you have a whole host of mixed issues there...
First, all the module files have to be in the root of the module zip, not in the magisk-module-DroidSansFallback you have them in now (this is the "not a Magisk module").
Second, your update-binary is a webpage... That ain't gonna work very well. When you download the module_installer.sh script, save it from the raw view (there's a button above the code when you open the file on GitHub).
Last (but this is only cosmetical really, since it won't affect anything) you found some really old module to base your work on, because the config.sh file hasn't been used for ages, and the readme file is ancient.
Fix the above and follow the instructions in the docs and you should be good to go.

Is there a current template on Git for the blank files?
I am here:
https://topjohnwu.github.io/Magisk/guides.html
Made the updates, going to try it now - but I would like to get a proper template setup

There is no longer an official template provided.
The current module installation setup is so simple that it really doesn't need it. Put whatever files you want to mount in /system, whatever boot script or prop files (as described in the docs) you want to run in the root of the zip, create the module.prop (again, described in the docs) so that you'll have some info about the module in the Manager, zip it up and flash it.
If you want to customise things more you do that with the customize.sh script (described in the docs).
If you really need a template there's always @Zackptg5's MMT-Ext...

So I downloaded a current module and looked through the files / structure and then the docs -- and now I have this
https://drive.google.com/file/d/1z4tlH6wGDpq0UnkxPF0f6i-DohcKnux-/view?usp=sharing
When I go to /system/fonts I now see DroidSansFallback.ttf (it was not present before installing the module)
and no error messages!!
I think I need to read a little more, on Android 5-8 adding this font into /system/fonts (manually) fixed my problem - now I am on Android 9 (OnePlus 6t TMO variant) and I do not see any changes from adding the file (fonts.xml issue?)
I really wanted to try this as a learning experience, and because the old method trips CTSProfile to false
I appreciate your patience - at least now I have a better starting point

All you need for the font file to be mounted is the /system/fonts/DroidSansFallback.ttf file in the module society directory. The REPLACE variable you've set in customize.sh is only for replacing directories with empty ones, not files (so you can remove it since it might be causing a conflict). Details in the docs:
https://topjohnwu.github.io/Magisk/guides.html#remove-folders

updated (linked file updated as well) no change.. .. ..
I did double check that the module places the file in the correct location, and when the module is disabled the file is removed

I found this on a random Google search (ASE) from a unrelated topic (Chinese character support)
On Android 9 it's Noto CJK, e. g. "Noto Sans CJK JP" font family (located in /system/fonts/NotoSansCJK-Regular.ttc). There is no DroidSansFallback.ttf anymore.
Could that explain why adding the file did not work?

Very possible. As you say, the module looks fine and works as intended (places the file where you want it), so the issue likely lies elsewhere.

I will take a stab at injecting a modified fonts.xml and see if that changes anything - thanks!

I experimented with adding a line into the fallback section of the fonts.xml (to reference the new font), and replacing the fonts.xml with a older version from Android 8 --- neither had any effect that I could discern

[Help] Creating Module for vendor partition changes

Hello Fellow Users,
Let me start with the fact that I have zero experience of making flash modules (TWRP/Magisk) and am just dabbling around.
Some background, I found a TWRP flash zip file which makes changes to vendor partition of Redmi Note 7 Pro (violet) running MIUI OS (Android Q) - this is a sound mod.
Now, with TWRP file the issue is that if it doesn't work or has any issues, we need to dirty flash ROM all times (or atleast dirty flash the vendor partition). There is no one-click remove option.
Hence I thought why can't the same be done via Magisk systemless and dabbled around a bit. Below is my experience of the last 2 days.
Now, coming to the original TWRP file - it copies/replaces three folders with included files to vendor partition. Path of folders is following
Code:
/vendor/etc
/vendor/lib/soundfx
/vendor/lib64/soundfx
These 3 folders and similarly named files within them already exist by default in the phone prior to flashing.
Now basis the Magisk guides I saw around and wiki from @Zackptg5 I did the following changes to the default template:
1) Edited customize.sh to define folders to be replaced
Code:
REPLACE="
/vendor/etc
/vendor/lib/soundfx
/vendor/lib64/soundfx"
2) Since Magisk will always look for the vendor under the system folder and so I moved the vendor folder under system folder
Basis same, created attached module and flashed and it installed.
But then three queries in my mind:
1) Are the new files actually replaced systemless and in-use? My concerns as don't see any intended change in sound
2) Is there a way to check if new files are being used o available to system?
3) Is this method of putting replace under customize.sh file the way out? While studying some similar modules making changes to vendor partition, I found that they have default (no change) customize.sh but rather make changes to common/post-fs-data.sh etc
So, looking forward to feedback from users experienced in making Magisk module. Thanks in advance for your time and efforts!
PS: attached is the WIP module which I wrote and also got installed in Magisk Manager
TLDR: How to make a Magisk Module using TWRP files to ensure systemless modification of folder/files in the vendor partition

1 - The REPLACE variable is used to replace the directories you specify with empty folders, not with what you want to add systemlessly. You might want to follow the advice written in the customize.sh file and read the documentation (@topjohnwu has everything explained there):
https://topjohnwu.github.io/Magisk/guides.html
Edit: If you do want to first "remove" (systemlessly, of course) everything in those folders, then keep them in the REPLACE variable. I just realised that it's a little unclear if that's what you want to do or not...
2 - That's the correct procedure. If all you want to do is to add or replace some files to your device, the only thing you need is to put those files in the /system directory of your module. That's it. The customize.sh file is used if you want to customise the installation logic of your module (not necessary if you're just adding files to your device) and post-fs-data.sh and service.sh are boot scripts to run code at boot (again not necessary if you're just adding files systemlessly to your device, see the linked docs for details).
Right now your module isn't adding anything, since the directories in the module's system folder are all empty. There's nothing to add. All it does is to replace those directories with empty ones (see #1 above). I'd say that using MMT is way overkill for such a simple module...
One you've installed a module Magisk will mount that modules files over your existing ones at boot. If the file under the real system path matches the one found in the module directory (under /data/adb/modules) everything is working as it should.

@Didgeridoohan Thanks for taking our time to give detailed reply and guidance
Finally was able to successfully install the module (named AudioEngine) and I do see files under /data/adb/modules but I have the following issue:
All these new files are under:
/data/adb/modules/AudioEngine/system/vendor folder and not under
/data/adb/modules/AudioEngine/vendor folder
Is that ok? If yes, why do we see /data/adb/modules/AudioEngine/vendor separately too?
Attached is final module as well as the screenshot of /data/adb/modules/AudioEngine/ as seen in file manager.

The /vendor folder is a symlink to /system/vendor, created by Magisk. That's just how Magisk works...
From your screenshot it looks like things are working as they should.
That uninstall script looks unnecessary though. The module isn't placing or altering anything outside the module folder, so when uninstalled there won't be any leftovers anyway.

im also try to do something similar with some audio libs in vendor partition for poco f2 with miui12 however if i add any libs to go into vendor/lib, for some strange reason, i lose wifi. theres no issues if vendor/lib/soundfx or vendor/lib64 is occupied with files just the lib directory only. the actual files that are going into lib are not replacing anything but are new files

[Request help] Making flashable zip to add carrier mbn files

I have a Pixel 5.
The stock rom does not have South Korean carrier mbn files.
I managed to source the files from the Internet.
I tried to copy paste it into
/system/vendor/rfs/msm/mpss/readonly/vendor/mbn/mcfg_sw/generic/Pixel
but it doesn't work (I can't change folder properties to write).
I tried using the volte_switch.zip from this guide
Module to enable 5G/VoLTE/VoWIFI on Pixel4a 5G/Pixel5
Update (9 Oct 2022): Upload module here. Update (7 Apr 2021): If you are looking for the manual way to add 5G support besides the magisk module way or the module does not work for you. Please refer to #54 for the detailed steps. Thanks again to...
forum.xda-developers.com
and modified the files to add the mbn files of my choice but flashing the zip deletes all folders under generic/Pixel/ except my country's folder.
Removing the "module" from magisk manager and rebooting brings everything back.
Is it possible to make a flashable zip to add the mbn files?
Or does it require repacking the radio.img?
Or does the volte_switch.zip install the mbn files systemlessly?

If you post your Magisk module it might be easier to say why it doesn't work.
But if the Pixel directory is emptied out it sounds like you have a replace file in there causing issues. Just guessing though...

Didgeridoohan said:
If you post your Magisk module it might be easier to say why it doesn't work.
But if the Pixel directory is emptied out it sounds like you have a replace file in there causing issues. Just guessing though...
Click to expand...
Click to collapse
Thanks for the suggestion. I've uploaded the flash zip file as well. When I went through the install script, I did notice the "replace" code in there. How should I change it to?

Ok after much googling, I figured out.
I added in all my original mbn folders as well and then typed in:
REPLACE="
/system/vendor/rfs/msm/mpss/readonly/vendor/mbn/mcfg_sw/
"
into customize.sh
This Replaced the folder with all the original and new mbn files.

Ok, I thought it worked but it's not actually working.
The new mbn files seems to be there but when I force a mbn reload by changing sim cards, it still loads the "original" files as if the new files aren't actually there.
For countries/carriers that's not listed in google's official supported list, the phone uses a 'generic' carrier mbn which is located in the generic/pixel/common/wildcard/pixel_wildcard/mcfg_sw.mbn.
This wildcard mbn is the generic carrier file that has 5G disabled by default. So in theory, all I need to do is replace the wildcard mbn with a different carrier's mbn which has 5G enabled by default. Then create magisk module and flash it to have it replaced.
My module appears to replace the files but the new files don't actually get loaded. When I change sim cards to force a reloading of mbn file, It still loads the old files.
What can I do to fix this? Any help is appreciated. Thanks.
Attached is my module.

Calling @Didgeridoohan good sir, if you could kindly provide me with knowledge about the post above, if possible. Thanks.

swangjang said:
Calling @Didgeridoohan good sir, if you could kindly provide me with knowledge about the post above, if possible. Thanks.
Click to expand...
Click to collapse
Busy life...
In theory you shouldn't at all need to do that replace function and add back all the stock files with the module. Magisk should take care of mounting or replacing only the files you need, so anything else is just redundant... But if it works, sure.
But it seems like it doesn't.
If you can verify with a file explorer that the files have been replaced with the ones from your module and the values still are taken from the original files that very likely means that there's more to it than just replacing those files.
You could provide the module install log and the Magisk log (Canary release so that it's actually useful) to see if there's anything wrong there.