WSABuilds/README.md

152 lines
12 KiB
Markdown
Raw Normal View History

2022-12-31 15:34:21 +01:00
# MagiskOnWSA (For Windows 10 and 11)
2023-01-02 19:39:52 +01:00
## (Windows Subsystem For Android™ (WSA) with Google Play Services and / or Magisk)
2023-01-08 12:21:29 +01:00
<img src="https://img.shields.io/github/downloads/MustardChef/WSABuilds/total?label=Total%20Downloads&style=for-the-badge"/>
2023-01-07 00:13:24 +01:00
### **Before Continuing:**
2023-01-06 20:16:56 +01:00
> **Warning**
> ### [Read this before forking](https://github.com/MustardChef/WSABuilds#before-forking)
2023-01-02 19:43:29 +01:00
> ### :exclamation: **Important:**
2023-01-07 16:30:47 +01:00
> ### Prebuilt WSA Builds for Windows 11 in [Releases](https://github.com/MustardChef/WSABuilds/releases) HAVE NOT been modified in anyway prior and subsequent to running the MagiskOnWSA script and upload to Github.
> ### Prebuilt WSA Builds for Windows 10 in [Releases](https://github.com/MustardChef/WSABuilds/releases) ONLY have had AppxManifest.xml, icu.dll and WsaPatch.dll patched according to the WSAPatch guide before upload to Github.
2023-01-07 00:03:42 +01:00
> #### The same level of scrutiny should be applied with the WSA builds as with any other program that you download from the internet
2023-01-07 00:13:24 +01:00
&nbsp;
2023-01-03 14:37:32 +01:00
2023-01-07 00:13:24 +01:00
<img src="https://upload.wikimedia.org/wikipedia/commons/e/e6/Windows_11_logo.svg" width=14% height=14%>
2023-01-02 19:39:52 +01:00
2023-01-11 16:02:24 +01:00
[![win11down](https://img.shields.io/badge/Download%20Stable%20Build-Windows%2011-blue?style=for-the-badge&logo=windows11)](https://github.com/MustardChef/WSABuilds/releases/tag/Windows_11_2210.40000.7.0) &nbsp; &nbsp; [![win11downpre](https://img.shields.io/badge/Download%20Insider%20Build-Windows%2011-red?style=for-the-badge&logo=windows11)](https://github.com/MustardChef/WSABuilds/releases/tag/Windows_11_2211.40000.10.0)
2023-01-02 19:43:01 +01:00
2023-01-07 00:13:56 +01:00
<img src="https://upload.wikimedia.org/wikipedia/commons/0/05/Windows_10_Logo.svg" width=14% height=14%>
2023-01-07 00:13:24 +01:00
2023-01-11 16:02:24 +01:00
[![win10down](https://img.shields.io/badge/Download%20Stable%20Build-Windows%2010-blue?style=for-the-badge&logo=windows)](https://github.com/MustardChef/WSABuilds/releases/tag/Windows_10_2210.40000.7.0) &nbsp; &nbsp; [![win10downpre](https://img.shields.io/badge/Download%20Insider%20Build-Windows%2010-red?style=for-the-badge&logo=windows)](https://github.com/MustardChef/WSABuilds/releases/tag/Windows_10_2211.40000.10.0)
2023-01-07 00:13:24 +01:00
&nbsp;
2022-08-30 02:48:37 +02:00
2022-12-30 23:42:01 +01:00
## Requirements
2023-01-02 14:45:39 +01:00
| <img src="https://upload.wikimedia.org/wikipedia/commons/e/e6/Windows_11_logo.svg" width=40% height=40%> | <img src="https://upload.wikimedia.org/wikipedia/commons/0/05/Windows_10_Logo.svg" width=50% height=50%> |
|-----------------------|-----------------------|
2022-12-31 16:15:57 +01:00
| - RAM: 6 GB (not recommended), 8 GB (minimum) and 16 GB (recommended).|- RAM: 6 GB (not recommended), 8 GB (minimum) and 16 GB (recommended).|
2022-12-30 23:42:01 +01:00
|- Processor: Your PC should meet the basic Windows 11 requirements i.e Core i3 8th Gen, Ryzen 3000, Snapdragon 8c, or above.| - Processor: N/A (This is a bit of a hit or miss)
|- Processor type: x64 or ARM64.| - Processor type: x64 or ARM64.|
2023-01-02 14:06:57 +01:00
|- Virtual Machine Platform Enabled: <br /> This optional setting is for virtualization and you can enable the setting from Control Panel/ Optional Features.| - Virtual Machine Platform Enabled: <br /> This optional setting is for virtualization and you can enable the setting from Control Panel/ Optional Features.|
|- Storage: Solid-state drive (SSD) <br /> - Hard Disk Drive (HDD) (NOT RECOMMENDED).| - Storage: Solid-state drive (SSD) <br /> - Hard Disk Drive (HDD) (NOT RECOMMENDED).|
|- Windows 11: Build 22000.526 or higher.| - Windows 10: 22H2 10.0.19045.2311 or higher. <br /> - May work on Windows 10 [21H2 10.0.19044.2311](https://user-images.githubusercontent.com/68516357/210234947-233d9207-6b54-4f70-99b3-2267bb542098.png)|
2022-12-30 23:48:31 +01:00
|- The Computer must support virtualization and be enabled in BIOS/UEFI and Optional Features. ![Guide]("https://support.microsoft.com/en-us/windows/enable-virtualization-on-windows-11-pcs-c5578302-6e43-4b4b-a449-8ced115f58e1")|- The Computer must support virtualization and be enabled in BIOS/UEFI and Optional Features. ![Guide]("https://support.microsoft.com/en-us/windows/enable-virtualization-on-windows-11-pcs-c5578302-6e43-4b4b-a449-8ced115f58e1")|
2022-12-30 23:06:27 +01:00
2022-05-30 00:14:27 +02:00
## Installation
2023-01-02 19:39:52 +01:00
> **Note** :
> If you have the official WSA installed, you must [completely uninstall](#uninstallation) it to use MagiskOnWSA
2022-05-30 00:14:27 +02:00
2022-09-19 22:18:42 +02:00
1. Go to the [Releases page](https://github.com/PeterNjeim/MagiskOnWSA/releases/latest)
2023-01-02 19:39:52 +01:00
> **Note**
>: To request a newer WSA build or a WSA build with a different version of GApps or Magisk or a build without them (root or Google Play), feel free to open an issue in the [Issues page](https://github.com/MustardChef/WSABuilds/issues).
2022-05-30 00:14:27 +02:00
2. In the latest release, go to the Assets section and download the WSA 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
2022-09-07 04:02:54 +02:00
> Note: If you're updating WSA, merge the folders and replace the files for all items when asked
6. Open the WSA folder and double-click `Run.bat`
2022-08-30 00:14:34 +02:00
7. Once the installation process completes, WSA 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
2022-05-30 00:14:27 +02:00
## Uninstallation
> 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%\Packages\MicrosoftCorporationII.WindowsSubsystemForAndroid_8wekyb3d8bbwe\LocalCache` folder.
2022-05-30 00:14:27 +02:00
1. Go to the Start Menu
2. Type `Windows Subsystem for Android`
3. Once the WSA app shows, click `App settings` in the right pane
2022-06-18 23:35:43 +02:00
4. In the Settings window that opens, scroll down and click `Terminate`
2022-05-30 00:14:27 +02:00
5. Click `Repair`
6. Click `Reset`
7. Close the Settings app
8. Go to the Start Menu
9. Type `Windows Subsystem for Android`
10. Once the WSA app shows, click `Uninstall` in the right pane
2023-01-02 19:43:01 +01:00
## Before Forking
| :exclamation: **Important:** &nbsp; `⚠DO NOT FORK⚠` |
|------------------------------------------------------------------------|
2023-01-06 20:17:31 +01:00
**This repository is designed specifically not to be forked. This does not use the same mechanism as the original MagiskOnWSA, as the original mechanism is slow and unreliable, and also violates GitHub's Terms of Service due to abuse of GitHub Actions in forks. Don't fork this repository unless you're a developer and want to modify the code itself or want to download a specific configuration of WSA not already available in the [Releases page](https://github.com/MustardChef/WSABuilds/releases).**
2023-01-02 19:43:01 +01:00
2022-05-30 00:14:27 +02:00
## Help
2023-01-08 13:10:55 +01:00
**Help me, I am having problems with the MagiskOnWSA**
2022-12-31 15:34:21 +01:00
- Open an issue and describe the issue with sufficent detail
2023-01-08 13:10:55 +01:00
**Help me, I am having problems with installing WSA on Windows 10**
2022-12-31 15:34:21 +01:00
- I am not working on the patch, and nor claim to. For full support visit the project homepage and open an issue there: https://github.com/cinit/WSAPatch/issues/
2023-01-08 13:10:55 +01:00
**How do I get a logcat?**
2022-05-17 18:25:56 +02:00
- `adb logcat`
2022-05-30 00:14:27 +02:00
or
- `%LOCALAPPDATA%\Packages\MicrosoftCorporationII.WindowsSubsystemForAndroid_8wekyb3d8bbwe\LocalState\diagnostics\logcat`
2022-05-30 00:14:27 +02:00
2023-01-08 13:10:55 +01:00
**How do I update Magisk?**
2021-12-14 17:32:05 +01:00
- Wait for a new MagiskOnWSA release that includes the newer Magisk version, then follow the [Installation instructions](#installation) to update
2022-05-30 00:14:27 +02:00
2023-01-08 13:10:55 +01:00
**Can I pass SafetyNet/Play Integrity?**
2021-12-14 17:32:05 +01:00
- No. Virtual machines like WSA cannot pass these mechanisms on their own due to the lack of signing by Google. Passing requires more exotic (and untested) solutions: <https://github.com/kdrag0n/safetynet-fix/discussions/145#discussioncomment-2170917>
2022-05-30 00:14:27 +02:00
2023-01-08 13:10:55 +01:00
**What is virtualization?**
2021-12-14 17:32:05 +01:00
- Virtualization is required to run virtual machines like WSA. `Run.bat` helps you enable it. After rebooting, re-run `Run.bat` to install WSA. If it's still not working, you have to enable virtualization in your BIOS/UEFI. Instructions vary by PC vendor, look for help online
2022-05-30 00:14:27 +02:00
2023-01-08 13:10:55 +01:00
**Can I remount system partition as read-write?**
2021-12-14 17:32:05 +01:00
- No. WSA 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
2022-05-30 00:14:27 +02:00
2023-01-08 13:10:55 +01:00
**How do I uninstall Magisk?**
2021-12-14 17:32:05 +01:00
2022-12-30 23:22:12 +01:00
- Download a WSA version that doesn't include Magisk from the [Releases page](https://github.com/MustardChef/WSABuilds/releases/latest). Then follow the [Installation instructions](#installation)
2021-12-14 17:32:05 +01:00
2023-01-08 13:10:55 +01:00
**Can I switch between OpenGApps and MindTheGapps?**
2021-12-14 17:32:05 +01:00
- No. GApps will no longer function. Do a [complete uninstallation](#uninstallation) before switching
2023-01-08 13:10:55 +01:00
**How do I install custom Magisk or GApps?**
1. Fork this repository
2. **A)** Magisk
1. **a)** Via local file:
2022-11-16 19:16:02 +01:00
1. Create a folder named `download` in the root
2. Move your custom Magisk APK/ZIP file to the `download` folder and rename it to `magisk-debug.zip`
2. In GitHub Actions, click on `Build MagiskOnWSA`
3. Choose `Custom` in the `Magisk Version` field
4. **b)** Via URL:
1. Input the URL pointing to your custom Magisk APK/ZIP file in the `Custom Magisk APK/ZIP URL` field
3. **B)** GApps
1. **a)** Via local file:
2022-11-16 19:16:02 +01:00
1. Create a folder named `download` in the root
2. Move your custom OpenGApps or MindTheGapps ZIP file to the `download` folder and rename it to `OpenGApps-{arch}-{variant}.zip` or `MindTheGapps-{arch}.zip` *(e.g. `OpenGApps-x64-pico.zip` or `MindTheGapps-arm64.zip`)*
2. In GitHub Actions, click on `Build MagiskOnWSA`
3. Choose `Custom (OpenGApps)` or `Custom (MindTheGapps)` in the `GApps Variant` field
4. **b)** Via URL:
1. Input the URL pointing to your custom OpenGApps or MindTheGapps ZIP file in the `Custom GApps ZIP URL` field
2021-12-14 17:32:05 +01:00
2021-10-27 15:11:39 +02:00
## Credits
2022-05-17 18:25:56 +02:00
2023-01-03 13:29:38 +01:00
- [Microsoft](https://apps.microsoft.com/store/detail/windows-subsystem-for-android%E2%84%A2-with-amazon-appstore/9P3395VX91NR): 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](https://support.microsoft.com/en-gb/windows/microsoft-software-license-terms-microsoft-windows-subsystem-for-android-cf8dfb03-ba62-4daa-b7f3-e2cb18f968ad) and [Privacy Policy](https://privacy.microsoft.com/en-gb/privacystatement)
2023-01-09 01:26:24 +01:00
- [PeterNjeim](https://github.com/PeterNjeim/MagiskOnWSA): For providing and continuing the development of the script made by LSPosed, this Github Repository and the Github Action workflow 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. Most Windows 11 Build rely on the Github Action provided to build, hence credit is given where due
- [Cinit and the WSAPatch Guide](https://github.com/cinit/WSAPatch): 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
2022-07-22 19:18:16 +02:00
- [StoreLib](https://github.com/StoreDev/StoreLib): API for downloading WSA
- [Magisk](https://github.com/topjohnwu/Magisk): The Magic Mask for Android
- [The Open Google Apps Project](https://opengapps.org): Script the automatic generation of up-to-date Google Apps packages
- [WSA-Kernel-SU](https://github.com/LSPosed/WSA-Kernel-SU): A kernel module to provide /system/xbin/su to Android Kernel
- [Kernel Assisted Superuser](https://git.zx2c4.com/kernel-assisted-superuser): Kernel assisted means of gaining a root shell for Android
2021-10-27 15:11:39 +02:00
- [WSAGAScript](https://github.com/ADeltaX/WSAGAScript): The first GApps integration script for WSA
2022-08-24 03:36:18 +02:00
- [MagiskOnWSA](https://github.com/LSPosed/MagiskOnWSA): `Deprecated` Integrate Magisk root and Google Apps into WSA
- [MagiskOnWSALocal](https://github.com/LSPosed/MagiskOnWSALocal): Integrate Magisk root and Google Apps into WSA