WSABuilds      

MagiskOnWSA (For Windows™ 10 and 11)

Windows Subsystem For Android™ (WSA) with Google Play Services and (or) Magisk

  ⚠️ Forking Information ⚠️

❗ Important:   ⚠️DO NOT FORK⚠️
This repository is designed specifically not to be forked. MagiskOnWSA and some of the various forks and clones that have sprung up on the platform (potentially) violate GitHub's Terms of Service due to abuse of GitHub Actions and have been ultimately warned, disabled or banned.
We would like to say one thing: We respect the Terms and Conditions set out by Github to its users. MagiskOnWSA Builds are built using the MagiskOnWSALocal script, patched in the case of Windows 10 Builds and uploaded onto Github and hence do not rely on the use of Github Actions.
Therefore, don't fork this repository unless you're a developer and want to modify the code itself and/or want to contribute to this Github repository.

 

Language/语言

• 中文
• English
• Want to contribute to the translation of this repo? Feel free to open a pull request.
  如果您想为该版本的翻译工作做出贡献，请随时打开一个拉动请求。

Downloads

  ℹ️Download Disclaimer

Warning

❗ Important:

Prebuilt Windows Subsystem For Android™ Builds for Windows™ 11 in Releases HAVE NOT been modified in anyway prior and subsequent to running the MagiskOnWSA script and upload to Github.

Prebuilt Windows Subsystem For Android™ Builds for Windows™ 10 in Releases ONLY have had AppxManifest.xml, icu.dll and WsaPatch.dll patched according to the WSAPatch guide before upload to Github.

I will move to a more transparent method of building MagiskOnWSA builds soon, due to the overarching concerns with safety, transparancy and build integrity

The same level of scrutiny should be applied with the Windows Subsystem For Android™ builds as with any other program that you download from the internet

  ❓Want to build your own custom build❓

❗ Important:   ⚠️DO NOT FORK⚠️
This repository is designed specifically not to be forked. MagiskOnWSA and some of the various forks and clones that have sprung up on the platform (potentially) violate GitHub's Terms of Service due to abuse of GitHub Actions and have been ultimately warned, disabled or banned.
Therefore, don't fork this repository unless you're a developer and want to modify the code itself and/or want to contribute to this Github repository.
If you want to create your Custom Build, please follow the instructions set out clearly, to avoid the repo from being taken down as a result of a misuse of Github Actions due to the large number of forks.

1. Star the WSABuilds repos (I will happy if you do that)

2. Check the version from Releases first. If it does not have the version you want, continue to follow this guide. If it does, then feel free to use those prebuild WSA builds

3. Open this page directly then choose the option that you want to build

4. Click "Create Issues" Button, the issues page will be generated and open. Then you click "Submit New Issues" (green button) and wait.

5. After about 15 minutes, the bot will reply that the workflow have built successfully (like the picture below), OPEN THE LINK BELOW THE BOT COMMENT

6. Download the package as artifact

DO NOT download it via multithread downloaders like IDM

7. Install like normal using the instructions in this repository

---

  The workflow didn't work ❓ Follow these step

1. Open the home page, click on the button (shown below) and select "import a repository" or go to this page directly

Step 1.1:

Step 1.2:

---

2. Copy the URL of this Repo and paste it into the the text box below and press "Import"

---

3. Go to the Setting tab in your newly imported repo and enable "Github Actions"

Step 3.1:

Step 3.2:

---

4. Then, scroll down until you reach the section titled "Workflow Permission" and follow the steps as shown in the image below

---

5. Open this link in new tab, then follow the step below. FINALLY, SCROLL DOWN AND CLICK GENERATE TOKEN

---

6. The key will appear. Then click the copy button at right side of the key.

---

7. Now, back to your repository Setting tab, and open Secret and Variable, then click Action. Next click New reporistory secret button

---

8. In the name boxes, type PAT. Next, paste your copied Secret key to Secret boxes, then click Add Secrets button

---

9. Now, Go to the Action tab

---

10. In the left sidebar, click the Custom Build workflow.

---

11. Above the list of workflow runs, select Run workflow

---

12. Select your desired options such as Magisk Version, WSA Release Channel + WSA Archetecture , GApps Varient and Compression Format then click Run workflow

---

13. Wait for the action to complete and download the artifact

DO NOT download it via multithread downloaders like IDM

---

14. Install like normal using the instructions in this repository and most important of all....

Enjoy!

  ❓Want to request a prebuilt custom build❓

Note

To request:
- A newer build
- A build with a different version of GApps (Google Play Services) or Magisk (root)
- A build without Magisk (root) or GApps (Google Play Services)
Feel free to open an issue in the Issues page.

Requested (Custom) Builds can be in the "Custom Builds" section below.

Operating System	Download Page	Download Mirrors
	Custom Builds:

 

Requirements

Windows Build Number	Windows™ 11: Build 22000.526 or higher.	Windows™ 10: 22H2 10.0.19045.2311 or higher. From WSA version 2301.40000.7.0 and higher in this repo, there is Unofficial support for Windows™ 10: 20H1 10.0.19041.264 or higher**. You must install KB5014032 then install KB5022834 to use WSA on these older Windows 10 builds
RAM	4 to 6 GB (Not Recommended) 8 GB (Minimum) 16 GB (Recommended)
Processor	CPU Architecture: x86_64 or arm64
	Your PC should meet the basic Windows™ 11 requirements i.e Core i3 8th Gen, Ryzen 3000, Snapdragon 8c, or above	N/A This is a bit of a hit or miss, but it is highly recommended that your processor is listed in the supported CPU lists for Windows 11 requirements
GPU	Any compatible Intel, AMD or Nvidia GPU. GPU Performance may vary depending on its compatibility with Windows Subsystem For Android™ Users with Intel HD Graphics 530 and older WSA may not start or graphical glitches will occur when Intel HD Graphics 530 and Older iGPUs are used. This is a known issue, but unfortunately there are no fixes that I currently know of, plus, these GPUs are too old and do not meet Windows 11 requirements and hence are not offical supported. Follow this guide to switch to another iGPU/dGPU/eGPU that you may have or Microsoft Basic Renderer Users with Nvidia GPUs Nvidia GPUs are known to cause problems. If Windows Subsystem For Android™ does not start or there are graphical glitches when an Nvidia GPU is used, follow this guide to switch to another iGPU/dGPU/eGPU that you may have or Microsoft Basic Renderer
Storage	Solid-state drive (RECOMMENDED) OR Hard Disk Drive (HDD) (NOT RECOMMENDED)
	Minimum Storage Requirements: You must have at least 10GB free on the system drive (C:\)
Partition	NTFS ONLY Windows Subsystem For Android™ can only be installed on a NTFS partition, not on an exFAT partition
Windows Features Needed	Virtual Machine Platform Enabled
	Windows Hypervisor Platform Enabled
	Windows Subsystem For Linux™ Enabled (Optional)
	Hyper V Enabled (Optional)
	These optional settings are for virtualization and provide components that are needed to run WSA. You can enable these settings by pressing the Windows Key + R on your keyboard and typing "OptionalFeatures.exe" into the box, pressing enter and selecting the features above followed by pressing apply
Virtualization	The Computer must support virtualization and be enabled in BIOS/UEFI and Optional Features. Guide on how to enable

 

  Installation

 

Note

: If you have the official Windows Subsystem For Android™ installed, you must completely uninstall it to use MagiskOnWSA.

In case you want to preserve your data from the previous installation (official or MagiskOnWSA), you can backup %LOCALAPPDATA%\Packages\MicrosoftCorporationII.WindowsSubsystemForAndroid_8wekyb3d8bbwe\LocalCache\userdata.vhdx before uninstallation and restore it after installation.

1. Go to the Releases page
2. In the latest release, go to the Assets section and download the Windows Subsystem For Android™ version of your choosing (do not download "Source code")
3. Extract the zip file
4. Delete the zip file
5. Move the newly extracted folder to a suitable location (Documents folder is a good choice), as you will need to keep the folder on your PC to use MagiskOnWSA

Note

:
If you're updating WSA, merge the folders and replace the files for all items when asked

6. Open the Windows Subsystem For Android™ folder: Search for and double-click Run.bat

   • If you previously have a MagiskOnWSA installation, it will automatically uninstall the previous one while preserving all user data and install the new one, so don't worry about your data.

   • If the popup windows disappear without asking administrative permission and Windows Subsystem For Android™ is not installed successfully, you should manually run Install.ps1 as administrator:

     • Press Win+x and select Windows™ Terminal (Admin)

     • Input the command below and press enter, replacing {X:\path\to\your\extracted\folder} including the {} with the path of the extracted folder

       cd "{X:\path\to\your\extracted\folder}"
       

     • Input the command below and press enter

       PowerShell.exe -ExecutionPolicy Bypass -File .\Install.ps1
       

     • The script will run and Windows Subsystem For Android™ will be installed

     • If this workaround does not work, your PC is not supported for WSA

7. Once the installation process completes, Windows Subsystem For Android™ will launch (if this is a first-time install, a window asking for consent to diagnositic information will be shown instead. Sometimes two identical windows will show, this is fine and nothing bad happens if you click OK in both windows)

8. Click on the PowerShell window, then press any key on the keyboard, the PowerShell window should close

9. Close File Explorer

10. Enjoy

 

Notice (Applicable for both Windows 10 and 11):

1. You can NOT delete the Windows Subsystem For Android™ installation folder. What Add-AppxPackage -Register .\AppxManifest.xml does is to register an appx package with some existing unpackaged files, so you need to keep them as long as you want to use Windows Subsystem For Android™. Check https://learn.microsoft.com/en-us/powershell/module/appx/add-appxpackage?view=windowsserver2022-ps for more details.
2. You need to register your Windows Subsystem For Android™ appx package before you can run Windows Subsystem For Android™. For WSABuilds and MagiskOnWSALocal users, you need to run Run.bat in the extracted dir. If the script fails, you can take the following steps for diagnosis (admin privilege required):

   1. Open a PowerShell window and change working directory to your Windows Subsystem For Android™ directory.

   2. Run the command below in PowerShell. This should fail with an ActivityID, which is a UUID required for the next step.

      Add-AppxPackage -ForceApplicationShutdown -ForceUpdateFromAnyVersion -Register .\AppxManifest.xml
      

   3. Run the command below in PowerShell. This should print the log of the failed operation.

      Get-AppPackageLog -ActivityID <UUID>
      

   4. Check the log for the reason of failure and fix it.

 

  Updating

How do I update without losing any of my apps and data on Windows Subsystem for Android (WSA)

1. Download the latest build (that you want to update to)
2. Make sure Windows Subsystem For Android is not running (Click on "Turn off" in the WSA Settings and wait for the spinning loader to disappear)
3. Using 7-Zip, WinRAR or any other tool of choice, open the .zip file
4. Within the .zip archive open the subfolder (Example: WSA_2xxx.xxxxx.xx.x_xx_Release-Nightly-with-magisk-xxxxxxx-MindTheGapps-xx.x-RemovedAmazon)
5. Select all the files that are within this subfolder and extract them to the current folder where the file for Windows Subsystem For Android are (the folder you extracted, and installed WSA from)
6. When prompted to replace folders, select "Do this for all current items" and click on "Yes"
7. When prompted to replace files, click on "Replace the files in the destination"
8. Run the Run.bat file
9. Launch Windows Subsystem For Android Settings app and go to the About tab using the sidebar
10. Check if the WSA version matches the latest version/ the version number that you want to update to

Join the Discord if you are having any difficulties

 

  Uninstallation

 

New CLI and GUI Uninstall Tool Coming Soon! Join the Discord for announcements and updates.

Note

:

If you want to preseve your data, make a backup of the %LOCALAPPDATA%\Packages\MicrosoftCorporationII.WindowsSubsystemForAndroid_8wekyb3d8bbwe\LocalCache\userdata.vhdx file. After uninstalling, copy the VHDX file back to the %LOCALAPPDATA%\Package\MicrosoftCorporationII.WindowsSubsystemForAndroid_8wekyb3d8bbwe\LocalCache folder. For a more comprehensive and detailed guide, take a look at the Backup and Restore section in this README markdown

• To remove WSA installed through WSABuild:

  • 1.) Make sure that Windows Subsystem For Android™ is not running

  • 2.) Search for Windows Subsystem For Android™ Settings using the built-in Windows Search, or through Add and Remove Programs and press uninstall

  • 3.) Delete the WSA folder that extracted you extracted and Run.bat was run from to install WSA (MagiskOnWSA folder)

  • 4.) Go to %LOCALAPPDATA%/Packages/ and delete the folder named MicrosoftCorporationII.WindowsSubsystemForAndroid_8wekyb3d8bbwe

    • If you get an error that states that the file(s) could not be deleted, make sure that WSA is turned off

• To remove WSA installed from the Microsoft Store:

  • 1.) Search for Windows Subsystem For Android™ Settings using the built-in Windows Search, or through Add and Remove Programs and press uninstall

 

  Backup and Restore Userdata

Backing Up Your Userdata

In order to make a backup of your WSA data you must copy the Userdata.vhdx (which includes, but is not limited Android Apps and their data, settings etc.), located at %LOCALAPPDATA%\Packages\MicrosoftCorporationII.WindowsSubsystemForAndroid_8wekyb3d8bbwe\LocalCache\userdata.vhdx, to a safe location

Restoring Your Backup

Before attempting to restore your backup, you must remove WSA if installed. Then before you run the "Run.bat" script (to reinstall WSA after removing it), you need to remove these two lines from Install.ps1:

Start-Process "wsa://com.topjohnwu.magisk"
Start-Process "wsa://com.android.vending"

After running the script, do not run WSA at all, and go to %localappdata%\Packages and (if the folders do not exist, create them) in MicrosoftCorporationII.WindowsSubsystemForAndroid_8wekyb3d8bbwe\LocalCache\ paste the userdata.vhdx

Now run WSA and your serdata should hopefully be restored

 

  FAQ

  Help me, I am having problems with the MagiskOnWSA Builds

• Open an issue in Github or join the Discord and describe the issue with sufficent detail

Help me, I am having problems with installing Windows Subsystem For Android™ on Windows™ 10

• I am not working on the patch, and nor claim to. Open an issue in the Discord or Github, and I will try to assist you with the problem if possible. For full support visit the project homepage and open an issue there: https://github.com/cinit/WSAPatch/issues/

How do I get a logcat?

• There are two ways:

  adb logcat
  

  or

• Location in Windows --->
  %LOCALAPPDATA%\Packages\MicrosoftCorporationII.WindowsSubsystemForAndroid_8wekyb3d8bbwe\LocalState\diagnostics\logcat

Can I delete the installed folder?

• No.

How can I update Windows Subsystem For Android™ to a new version?

• As Explained Installation instructions. Download the latest Windows Subsystem For Android™ Version and replace the content of your previous installation and rerun Install.ps1. Don't worry, your data will be preserved

How do I update Magisk?

• Do the same as updating Windows Subsystem For Android™. Wait for a new MagiskOnWSA release that includes the newer Magisk version, then follow the Installation instructions to update

Can I pass SafetyNet/Play Integrity?

• No. Virtual machines like Windows Subsystem For Android™ cannot pass these mechanisms on their own due to the lack of signing by Google. Passing requires more exotic (and untested) solutions like: https://github.com/kdrag0n/safetynet-fix/discussions/145#discussioncomment-2170917

What is virtualization?

• Virtualization is required to run virtual machines like Windows Subsystem For Android™. Run.bat helps you enable it. After rebooting, re-run Run.bat to install Windows Subsystem For Android™. If it's still not working, you have to enable virtualization in your BIOS/UEFI. Instructions vary by PC vendor, look for help online

Can I remount system partition as read-write?

• No. Windows Subsystem For Android™ is mounted as read-only by Hyper-V. You can, however, modify the system partition by creating a Magisk module, or by directly modifying the system.img file

I cannot adb connect localhost:58526

• Make sure developer mode is enabled. If the issue persists, check the IP address of Windows Subsystem For Android™ on the Settings ---> Developer page and try

  adb connect ip:5555
  

Magisk online module list is empty?

• Magisk actively removes the online module repository. You can install the module locally or by

  Step 1

  adb push module.zip /data/local/tmp
  

  Step 2

  adb shell su -c magisk --install-module /data/local/tmp/module.zip
  

How do I uninstall Magisk?

• Request, using Issues, a Windows Subsystem For Android™ version that doesn't include Magisk from the Releases page. Then follow the Installation instructions

Can I switch between OpenGApps and MindTheGapps?

• No. GApps will no longer function. Do a complete uninstallation before switching

How do I install custom Magisk or GApps?

• To request a build with custom Magisk or GApps, feel free to open an issue in the Issues page You can also achieve this by using the MagiskOnWSALocal Script and following the provided instructions located in the repo.

 

  Usage Guides

 

GPU Guide:

Sideload Guide:

Moving WSA to another drive or partition:

Installing KernelSU

Installing BusyBox

 

  Having Issues?

Common Issues:

 

  Credits

• Microsoft: For providing Windows Subsystem For Android™ and related files. Windows Subsystem For Android™, Windows Subsystem For Android™ Logo, Windows™ 10 and Windows™ 11 Logos are trademarks of Microsoft Corporation. Microsoft Corporation reserves all rights to these trademarks. By downloading and installing Windows Subsystem For Android™, you agree to the Terms and Conditions and Privacy Policy
• YT-Advanced: For providing and continuing the development of the script made by LSPosed, the Github Action workflow guide is based on his Github Repo. I do not claim his work and the work of the many contributers as my own and nor intend to do so.
• Cinit and the WSAPatch Guide: Many thanks for the comprehensive guide, files and support provided by Cinit and the contributers at the WSAPatch repository. Windows™ 10 Builds in this repo rely on the hard work of this project and hence credit is given where due
• StoreLib: API for downloading WSA
• Magisk: The Magic Mask for Android
• The Open Google Apps Project: Script the automatic generation of up-to-date Google Apps packages
• WSA-Kernel-SU: A kernel module to provide /system/xbin/su to Android Kernel
• Kernel Assisted Superuser: Kernel assisted means of gaining a root shell for Android
• WSAGAScript: The first GApps integration script for WSA
• MagiskOnWSA: Deprecated Integrate Magisk root and Google Apps into WSA
• MagiskOnWSALocal: Integrate Magisk root and Google Apps into WSA
• Icons8: Icons used in this repo were obtained from Icon8. To view the links to the specific icons used in this Markdown, press here

The repository is provided as a utility.

Android is a trademark of Google LLC. Windows™ is a trademark of Microsoft LLC.