rootAVD

newbit @ xda-developers

A Script to...

root your Android Studio Virtual Device (AVD), with Magisk (Stable, Canary or Alpha)
patch its fstab
download and install the USB HOST Permissions Module for Magisk
install custom build Kernel and its Modules
download and install AOSP prebuilt Kernel and its Modules

...within seconds.

Install Magisk

Download rootAVD via

Click
git clone https://github.com/newbit1/rootAVD.git

Preconditions

the AVD is running
a working Internet connection for the Menu
a command prompt / terminal is opened
adb shell will connect to the running AVD

Use Case Examples

on MacOS

BlueStacks 4 on MacOS

on Windows

on Linux

Fake Boot.img on MacOS

How to Install ADB (Android SDK Platform-Tools)

Open Android Studio -> SDK Manager -> Android SDK -> SDK Tools -> Check on Android SDK Platform-Tools -> Apply

rootAVD Help Menu

rootAVD A Script to root AVD by NewBit XDA

Usage:	rootAVD [DIR/ramdisk.img] [OPTIONS] | [EXTRA_CMDS]
or:	rootAVD [ARGUMENTS]

Arguments:
	ListAllAVDs			Lists Command Examples for ALL installed AVDs

	EnvFixTask			Requires Additional Setup fix
					- construct Magisk Environment manual
					- only works with an already Magisk patched ramdisk.img
					- without [DIR/ramdisk.img] [OPTIONS] [PATCHFSTAB]
					- needed since Android 12 (S) rev.1
					- not needed anymore since Android 12 (S) API 31 and Magisk Alpha
					- Grant Shell Su Permissions will pop up a few times
					- the AVD will reboot automatically

	InstallApps			Just install all APKs placed in the Apps folder

Main operation mode:
	DIR				a path to an AVD system-image
					- must always be the 1st Argument after rootAVD
	
ADB Path | Ramdisk DIR:
	[M]ac/Darwin:			export PATH=~/Library/Android/sdk/platform-tools:$PATH
					~/Library/Android/sdk/system-images/android-$API/google_apis_playstore/x86_64/
	
	[L]inux:			export PATH=~/Android/Sdk/platform-tools:$PATH
					~/Android/Sdk/system-images/android-$API/google_apis_playstore/x86_64/
	
	[W]indows:			set PATH=%LOCALAPPDATA%\Android\Sdk\platform-tools;%PATH%
					%LOCALAPPDATA%\Android\Sdk\system-images\android-$API\google_apis_playstore\x86_64\
	
	$API:				25,29,30,S,etc.
	
Except for EnvFixTask, ramdisk.img must be untouched (stock).
	
Options:
	restore				restore all existing .backup files, but doesn't delete them
					- the AVD doesn't need to be running
					- no other Argument after will be processed
	
	InstallKernelModules		install custom build kernel and its modules into ramdisk.img
					- kernel (bzImage) and its modules (initramfs.img) are inside rootAVD
					- both files will be deleted after installation
	
	InstallPrebuiltKernelModules	download and install an AOSP prebuilt kernel and its modules into ramdisk.img
					- similar to InstallKernelModules, but the AVD needs to be online
	
Options are exclusive, only one at the time will be processed.
	
Extra Commands:
	DEBUG				Debugging Mode, prevents rootAVD to pull back any patched file
	
	PATCHFSTAB			fstab.ranchu will get patched to automount Block Devices like /dev/block/sda1
					- other entries can be added in the script as well
					- a custom build Kernel might be necessary

	GetUSBHPmodZ			The USB HOST Permissions Module Zip will be downloaded into /sdcard/Download
	
Extra Commands can be combined, there is no particular order.
	
Notes: rootAVD will
- always create .backup files of ramdisk.img and kernel-ranchu
- replace both when done patching
- show a Menu, to choose the Magisk Version (Stable || Canary || Alpha), if the AVD is online
- make the choosen Magisk Version to its local
- install all APKs placed in the Apps folder

Linux & MacOS

Command Examples:
./rootAVD.sh
./rootAVD.sh ListAllAVDs
./rootAVD.sh EnvFixTask
./rootAVD.sh InstallApps

./rootAVD.sh ~/Library/Android/sdk/system-images/android-31/google_apis_playstore/x86_64/ramdisk.img
./rootAVD.sh ~/Library/Android/sdk/system-images/android-31/google_apis_playstore/x86_64/ramdisk.img DEBUG PATCHFSTAB GetUSBHPmodZ
./rootAVD.sh ~/Library/Android/sdk/system-images/android-31/google_apis_playstore/x86_64/ramdisk.img restore
./rootAVD.sh ~/Library/Android/sdk/system-images/android-31/google_apis_playstore/x86_64/ramdisk.img InstallKernelModules
./rootAVD.sh ~/Library/Android/sdk/system-images/android-31/google_apis_playstore/x86_64/ramdisk.img InstallPrebuiltKernelModules
./rootAVD.sh ~/Library/Android/sdk/system-images/android-31/google_apis_playstore/x86_64/ramdisk.img InstallPrebuiltKernelModules GetUSBHPmodZ PATCHFSTAB DEBUG

Command Examples: for ALL installed AVDs

./rootAVD.sh
./rootAVD.sh ListAllAVDs
./rootAVD.sh EnvFixTask
./rootAVD.sh InstallApps

./rootAVD.sh ~/Library/Android/sdk/system-images/android-29/android-automotive-playstore/x86/ramdisk.img
./rootAVD.sh ~/Library/Android/sdk/system-images/android-29/android-automotive-playstore/x86/ramdisk.img DEBUG PATCHFSTAB GetUSBHPmodZ
./rootAVD.sh ~/Library/Android/sdk/system-images/android-29/android-automotive-playstore/x86/ramdisk.img restore
./rootAVD.sh ~/Library/Android/sdk/system-images/android-29/android-automotive-playstore/x86/ramdisk.img InstallKernelModules
./rootAVD.sh ~/Library/Android/sdk/system-images/android-29/android-automotive-playstore/x86/ramdisk.img InstallPrebuiltKernelModules
./rootAVD.sh ~/Library/Android/sdk/system-images/android-29/android-automotive-playstore/x86/ramdisk.img InstallPrebuiltKernelModules GetUSBHPmodZ PATCHFSTAB DEBUG

./rootAVD.sh ~/Library/Android/sdk/system-images/android-29/google_apis_playstore/x86_64/ramdisk.img
./rootAVD.sh ~/Library/Android/sdk/system-images/android-29/google_apis_playstore/x86_64/ramdisk.img DEBUG PATCHFSTAB GetUSBHPmodZ
./rootAVD.sh ~/Library/Android/sdk/system-images/android-29/google_apis_playstore/x86_64/ramdisk.img restore
./rootAVD.sh ~/Library/Android/sdk/system-images/android-29/google_apis_playstore/x86_64/ramdisk.img InstallKernelModules
./rootAVD.sh ~/Library/Android/sdk/system-images/android-29/google_apis_playstore/x86_64/ramdisk.img InstallPrebuiltKernelModules
./rootAVD.sh ~/Library/Android/sdk/system-images/android-29/google_apis_playstore/x86_64/ramdisk.img InstallPrebuiltKernelModules GetUSBHPmodZ PATCHFSTAB DEBUG

./rootAVD.sh ~/Library/Android/sdk/system-images/android-30/google_apis_playstore/x86_64/ramdisk.img
./rootAVD.sh ~/Library/Android/sdk/system-images/android-30/google_apis_playstore/x86_64/ramdisk.img DEBUG PATCHFSTAB GetUSBHPmodZ
./rootAVD.sh ~/Library/Android/sdk/system-images/android-30/google_apis_playstore/x86_64/ramdisk.img restore
./rootAVD.sh ~/Library/Android/sdk/system-images/android-30/google_apis_playstore/x86_64/ramdisk.img InstallKernelModules
./rootAVD.sh ~/Library/Android/sdk/system-images/android-30/google_apis_playstore/x86_64/ramdisk.img InstallPrebuiltKernelModules
./rootAVD.sh ~/Library/Android/sdk/system-images/android-30/google_apis_playstore/x86_64/ramdisk.img InstallPrebuiltKernelModules GetUSBHPmodZ PATCHFSTAB DEBUG

./rootAVD.sh ~/Library/Android/sdk/system-images/android-31/google_apis_playstore/x86_64/ramdisk.img
./rootAVD.sh ~/Library/Android/sdk/system-images/android-31/google_apis_playstore/x86_64/ramdisk.img DEBUG PATCHFSTAB GetUSBHPmodZ
./rootAVD.sh ~/Library/Android/sdk/system-images/android-31/google_apis_playstore/x86_64/ramdisk.img restore
./rootAVD.sh ~/Library/Android/sdk/system-images/android-31/google_apis_playstore/x86_64/ramdisk.img InstallKernelModules
./rootAVD.sh ~/Library/Android/sdk/system-images/android-31/google_apis_playstore/x86_64/ramdisk.img InstallPrebuiltKernelModules
./rootAVD.sh ~/Library/Android/sdk/system-images/android-31/google_apis_playstore/x86_64/ramdisk.img InstallPrebuiltKernelModules GetUSBHPmodZ PATCHFSTAB DEBUG

Windows

Command Examples:
rootAVD.bat
rootAVD.bat ListAllAVDs
rootAVD.bat EnvFixTask
rootAVD.bat InstallApps

rootAVD.bat %LOCALAPPDATA%\Android\Sdk\system-images\android-31\google_apis_playstore\x86_64\ramdisk.img
rootAVD.bat %LOCALAPPDATA%\Android\Sdk\system-images\android-31\google_apis_playstore\x86_64\ramdisk.img DEBUG PATCHFSTAB GetUSBHPmodZ
rootAVD.bat %LOCALAPPDATA%\Android\Sdk\system-images\android-31\google_apis_playstore\x86_64\ramdisk.img restore
rootAVD.bat %LOCALAPPDATA%\Android\Sdk\system-images\android-31\google_apis_playstore\x86_64\ramdisk.img InstallKernelModules
rootAVD.bat %LOCALAPPDATA%\Android\Sdk\system-images\android-31\google_apis_playstore\x86_64\ramdisk.img InstallPrebuiltKernelModules
rootAVD.bat %LOCALAPPDATA%\Android\Sdk\system-images\android-31\google_apis_playstore\x86_64\ramdisk.img InstallPrebuiltKernelModules GetUSBHPmodZ PATCHFSTAB DEBUG

Command Examples: for ALL installed AVDs

./rootAVD.bat
./rootAVD.bat ListAllAVDs
./rootAVD.bat EnvFixTask
./rootAVD.bat InstallApps

./rootAVD.bat %LOCALAPPDATA%\Android\Sdk\system-images\android-29\android-automotive-playstore\x86\ramdisk.img
./rootAVD.bat %LOCALAPPDATA%\Android\Sdk\system-images\android-29\android-automotive-playstore\x86\ramdisk.img DEBUG PATCHFSTAB GetUSBHPmodZ
./rootAVD.bat %LOCALAPPDATA%\Android\Sdk\system-images\android-29\android-automotive-playstore\x86\ramdisk.img restore
./rootAVD.bat %LOCALAPPDATA%\Android\Sdk\system-images\android-29\android-automotive-playstore\x86\ramdisk.img InstallKernelModules
./rootAVD.bat %LOCALAPPDATA%\Android\Sdk\system-images\android-29\android-automotive-playstore\x86\ramdisk.img InstallPrebuiltKernelModules
./rootAVD.bat %LOCALAPPDATA%\Android\Sdk\system-images\android-29\android-automotive-playstore\x86\ramdisk.img InstallPrebuiltKernelModules GetUSBHPmodZ PATCHFSTAB DEBUG

./rootAVD.bat %LOCALAPPDATA%\Android\Sdk\system-images\android-29\google_apis_playstore\x86_64\ramdisk.img
./rootAVD.bat %LOCALAPPDATA%\Android\Sdk\system-images\android-29\google_apis_playstore\x86_64\ramdisk.img DEBUG PATCHFSTAB GetUSBHPmodZ
./rootAVD.bat %LOCALAPPDATA%\Android\Sdk\system-images\android-29\google_apis_playstore\x86_64\ramdisk.img restore
./rootAVD.bat %LOCALAPPDATA%\Android\Sdk\system-images\android-29\google_apis_playstore\x86_64\ramdisk.img InstallKernelModules
./rootAVD.bat %LOCALAPPDATA%\Android\Sdk\system-images\android-29\google_apis_playstore\x86_64\ramdisk.img InstallPrebuiltKernelModules
./rootAVD.bat %LOCALAPPDATA%\Android\Sdk\system-images\android-29\google_apis_playstore\x86_64\ramdisk.img InstallPrebuiltKernelModules GetUSBHPmodZ PATCHFSTAB DEBUG

./rootAVD.bat %LOCALAPPDATA%\Android\Sdk\system-images\android-30\google_apis_playstore\x86_64\ramdisk.img
./rootAVD.bat %LOCALAPPDATA%\Android\Sdk\system-images\android-30\google_apis_playstore\x86_64\ramdisk.img DEBUG PATCHFSTAB GetUSBHPmodZ
./rootAVD.bat %LOCALAPPDATA%\Android\Sdk\system-images\android-30\google_apis_playstore\x86_64\ramdisk.img restore
./rootAVD.bat %LOCALAPPDATA%\Android\Sdk\system-images\android-30\google_apis_playstore\x86_64\ramdisk.img InstallKernelModules
./rootAVD.bat %LOCALAPPDATA%\Android\Sdk\system-images\android-30\google_apis_playstore\x86_64\ramdisk.img InstallPrebuiltKernelModules
./rootAVD.bat %LOCALAPPDATA%\Android\Sdk\system-images\android-30\google_apis_playstore\x86_64\ramdisk.img InstallPrebuiltKernelModules GetUSBHPmodZ PATCHFSTAB DEBUG

./rootAVD.bat %LOCALAPPDATA%\Android\Sdk\system-images\android-31\google_apis_playstore\x86_64\ramdisk.img
./rootAVD.bat %LOCALAPPDATA%\Android\Sdk\system-images\android-31\google_apis_playstore\x86_64\ramdisk.img DEBUG PATCHFSTAB GetUSBHPmodZ
./rootAVD.bat %LOCALAPPDATA%\Android\Sdk\system-images\android-31\google_apis_playstore\x86_64\ramdisk.img restore
./rootAVD.bat %LOCALAPPDATA%\Android\Sdk\system-images\android-31\google_apis_playstore\x86_64\ramdisk.img InstallKernelModules
./rootAVD.bat %LOCALAPPDATA%\Android\Sdk\system-images\android-31\google_apis_playstore\x86_64\ramdisk.img InstallPrebuiltKernelModules
./rootAVD.bat %LOCALAPPDATA%\Android\Sdk\system-images\android-31\google_apis_playstore\x86_64\ramdisk.img InstallPrebuiltKernelModules GetUSBHPmodZ PATCHFSTAB DEBUG

Notes

64 Bit Only Systems needs Magisk 23.x
In the Menu, you can choose between the newest Magisk, Canary, Stable and Alpha, Version.
With the new Option s, you can see and download any other Versions of Magisk
Once choosen, the script will make that Version to your local one.
Prebuilt Kernel and Modules will be pulled from AOSP
Starting Magisk from Terminal via adb shell monkey -p com.topjohnwu.magisk -c android.intent.category.LAUNCHER 1
API 28 (Pie) is not supported at all -> because

Notes for Apk Developers

How-To SU from Chainfire's libsuperuser - Guidelines for problem-free su usage (for Android Developers)
TopJohnWu's libsu - An Android library providing a complete solution for apps using root permissions

Fake Boot.img Function

During runtime, the script will launch the Magisk APK so that you can patch the fake Boot.img within 60s
The script also detects if there is already a patched Boot.img present
This feature lets you also update and switch between Magisk Versions
- Updating a patched ramdisk will delete the overlay.d folder, all mods are gone!

2 Ways to boot the AVD into Safe Mode

1st Way - If the AVD still boots normal:
- Tap and Hold the Power Button until the 3 Options appear
- Tap and Hold the Power Off Button until Reboot to safe mode appears
2nd Way - If the AVD stuck while booting (black screen):
- Tap and Hold the Volume Down Button
- The Time Window is between the Launching Emulator Bar is approx half way until the Google Boot Screen appears
Confirmation
- On the Bottom Left Corner reads: Safe mode

Automotive Notes

After patching the ramdisk.img and cycle power, switch to user 0 via adb shell am switch-user 0
- open the Magisk App and the Requires Additional Setup pops up -> reboot AVD
- switch again to user 0
  - open the Magisk App -> Settings -> Multiuser Mode -> User-Independent -> reboot AVD
Every time you want to Grant Su Permissions, switch to user 0 and then back to 10 adb shell am switch-user 10
Alternative, you can install the Module magisk-single-user
- and remove all user higher than 0 i.e. adb shell pm remove-user 13 or adb shell pm remove-user 10

BlueStacks 4 Notes on MacOs

Modules are working
Zygisk doesn't work
The Home Screen Apk closes as soon as Magisk APP is installed
- but you can start Magisk from Terminal via adb shell monkey -p com.topjohnwu.magisk -c android.intent.category.LAUNCHER 1
- and Hide the Magisk APP to Settings i.e.
ADB Connection is very buggy, adb kill-server is necessary quite often

Links

XDA [GUIDE] How to [Build|Mod|Update] a custom AVD Kernel and its Modules

[GUIDE][Build|Mod|Update][kernel-ranchu][goldfish][5.4][5.10][GKI][ramdisk.img][modules][rootAVD][Android 11(R) 12(S)][AVD][Google Play Store API]

How to root AVDs without Play Store (Google APIs) out of the box

Windows

open a terminal -> win + r cmd

add emulator to your PATH
find your AVD
launch your AVD with the -writable-system argument

 set PATH=%LOCALAPPDATA%\Android\Sdk\emulator;%PATH%
 emulator -list-avds
 	Pixel_4_API_29
 emulator -avd Pixel_4_API_29 -writable-system

open a 2nd terminal -> win + r cmd

enter the following commands one by one

 set PATH=%LOCALAPPDATA%\Android\Sdk\platform-tools;%PATH%
 adb root
 adb shell avbctl disable-verification
 adb disable-verity
 adb reboot
 adb root
 adb remount
 adb shell
 generic_x86_64:/ #

Compatibility Chart

Magisk v22.1+ Successfully tested with Stock Kernel on

Change Logs

[December 2022]

[rootAVD.sh] - Fixed arithmetic syntax error in decompress_ramdisk

[November 2022]

[General] - Bug fixes
[General] - Updated to Magisk Stable Version 25.2
[General] - Added FAKEBOOTIMG Use Case Examples as Gif
[rootAVD.sh] - Added support for adding the stub.apk if present
[General] - Added support for already patched ramdisk files
[General] - removed the EnvFixTask Argument
[General] - Bug fixes
[rootAVD.sh] - Added FAKEBOOTIMG Argument that creates a fake Boot.img which can be patched directed from the Magisk APK

[March 2022]

[rootAVD.sh] - Added toggleRamdisk Argument that toggles between patched and stock ramdisk
[rootAVD.sh] - Changed the need of a Magisk.zip file
[General] - Added Use Case Examples as Gif
[General] - Added Option to Download older Magisk Versions
[rootAVD.sh] - Added BlueStacks 4 Support on MacOS
[General] - Bug fixes

[February 2022]

[General] - Updated to Magisk Stable Version 24.1

Change Logs

[October 2021]

[rootAVD.sh] - Added get Up-To-Date Script Routine if Script is broken
[rootAVD.sh] - Updated LZ4 decompression Routine
[rootAVD.sh] - Updated InstallPrebuiltKernelModules Routine to support ARM64 Kernels
[rootAVD.sh] - Updated Busybox Extraction Routine
[General] - Added Multiarch Busybox Binarys and 64-Bit Only Support
[General] - Added Alpha Channel to the Menu
[rootAVD.bat] - Added Shut Down Feature
[rootAVD.sh] - Added Shut Down Feature
[General] - Added Android 12 (S) API 31 Status
[General] - Added Link to Android AppSecs Video about rootAVD

[July 2021]

[rootAVD.bat] - Changed TestADB
[General] - Added rootCROS Project to Links

[June 2021]

[General] - Android 12 (S) r05

[May 2021]

[General] - Updated to Magisk App v23.0
[rootAVD.sh] - Added "AddRCscripts" Argument that *install all custom .rc scripts, placed in the rootAVD folder, into ramdisk.img/overlay.d/sbin
[rootAVD.sh] - Added BusyBox Binary after the rootAVD script
[rootAVD.bat] - Added ListAllAVDs and InstallApps as Arguments
[rootAVD.sh] - Added "ListAllAVDs" Argument that Lists Command Examples for ALL installed AVDs
[rootAVD.sh] - Added "InstallApps" Argument to Just install all APKs placed in the Apps folder
[rootAVD.bat] - Added comprehensive Help Menu

[Apr. 2021]

[General] - Added comprehensive Help Menu
[rootAVD.sh] - Changed "DEBUG" "PATCHFSTAB" "GetUSBHPmodZ" to Arguments
[General] - Fixed some typos and functions
[rootAVD.sh] - Add a Menu to choose the prebuilt Kernel and Modules Version to install
[General] - Added "InstallPrebuiltKernelModules" download/update/install prebuilt kernel and modules
[General] - Added 2 Ways to boot the AVD into Safe Mode
[rootAVD.sh] - Added Android S rev 3 support
[General] - Added "InstallKernelModules" update/install custom build kernel and modules
[rootAVD.sh] - Added update_lib_modules function
[General] - Added "restore" to put back your backup files
[General] - Updated local Magisk App v22.1
[rootAVD.sh] - Added Option to Download the USB HOST Permissions Module

[Mar. 2021]

[General] - Add a Download Manager Function for bad TLS record using wget
[rootAVD.bat] - Adjustments to run with the updated rootAVD.sh
[General] - Add a Menu to choose the Magisk Version to install
[rootAVD.sh] - Added EnvFixTask Argument to fix Requires Additional Setup in Android S
[General] - Changed to BusyBox (D)ASH Standalone
[General] - Re-Structured Script
[rootAVD.sh] - Added "Additional Setup Required" manually for Android S
[rootAVD.sh] - Updated shakalaca's Ramdisk Repack Routine
[rootAVD.sh] - Added Compression Detection for LZ4 and GZ
[General] - Fixed some bugs and typos
[General] - Updated to Magisk App v22.0

Magisk v21.4 Successfully tested with Stock Kernel on

Credits

About

Script to root AVDs running with QEMU Emulator from Android Studio

GNU General Public License v3.0

Languages

Language:Batchfile 100.0%