Skip to content

Commit

Permalink
Minor fixes + formatting to README.md (#413)
Browse files Browse the repository at this point in the history
  • Loading branch information
@sn-o-w
sn-o-w authored Mar 15, 2023
1 parent 62d17d2 commit a4957ff
Showing 1 changed file with 75 additions and 58 deletions.
133 changes: 75 additions & 58 deletions docs/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,34 +6,38 @@

- Linux (x86_64 or arm64)

The following dependencies are required:
The following dependencies are required:

| DistrOS | | | | |
|:-------:|-------------------------------------------------------------------------------------------------|-------------------|------------|-----------|
| Debian | `lzip wine winetricks patchelf e2fsprogs aria2 python3 python3-pip aria2 p7zip-full attr unzip` | `setools` | `whiptail` | `xz-utils` |
| openSUSE Tumbleweed | Same as above | `setools-console` | `dialog` | `xz` |
| DistrOS | | | | |
|:-------------------:|-------------------------------------------------------------------------------------------------|-------------------|------------|------------|
| Debian | `lzip wine winetricks patchelf e2fsprogs aria2 python3 python3-pip aria2 p7zip-full attr unzip` | `setools` | `whiptail` | `xz-utils` |
| openSUSE Tumbleweed | Same as above | `setools-console` | `dialog` | `xz` |

The following components need to be installed using `winetricks`: `msxml6`
The following components need to be installed using `winetricks`: `msxml6`

The python3 library `requests` is used.
The python3 library `requests` is used.

Python version ≥ **3.7.2**.

- Recommended use

Python version ≥ **3.7.2**
- Recommended Use
- Ubuntu (You can use [WSL2](https://apps.microsoft.com/store/search?publisher=Canonical%20Group%20Limited))

Ready to use right out of the box.
Ready to use right out of the box.

- Debian (You can use [WSL2](https://apps.microsoft.com/store/detail/debian/9MSVKQC78PK6))

Need to add `contrib` sources to the source list to install winetricks.
Need to add `contrib` sources to the source list to install winetricks.

- openSUSE Tumbleweed (You can use [WSL2](https://apps.microsoft.com/store/detail/opensuse-tumbleweed/9MSSK2ZXXN11))

Ready to use right out of the box.
Ready to use right out of the box.

`run.sh` will handle all dependencies automatically.

No need to type any commands.
- Other Distributions

- Other distributions

Install the dependencies manually.

Expand All @@ -55,38 +59,38 @@

## Text Guide

1. Star (if you like)
2. Clone the repo to local
1. Star (if you like).
2. Clone the repo to local:

```bash
git clone https://github.com/LSPosed/MagiskOnWSALocal.git --depth 1
```

3. Run `cd scripts`
3. Run `cd scripts`.
4. Then run `./build.sh --help` (optional) to get the usage if you want to use CLI.
5. Run `./run.sh` under scripts directory.
6. Select the WSA version and its architecture (mostly x64).
7. Select the version of Magisk.
. Choose which brand of GApps you want to install
8. Choose which brand of GApps you want to install:
- OpenGApps

Select the [OpenGApps variant](https://github.com/opengapps/opengapps/wiki#variants) you like.
Select the [OpenGApps variant](https://github.com/opengapps/opengapps/wiki#variants) you like.
- MindTheGapps

There is no other variant we can choose.
8. Select the root solution (none means no root)
9. If you are running the script for the first time, it will take some time to complete. After the script completes, two new folders named `output` and `download` will be generated in the `MagiskOnWSALocal` folder. Go to the `output` folder. While running the `./run.sh` script in the step 3, if you selected `Yes` for `Do you want to compress the output?` then in `output` folder you will see a compressed file called `WSA-with-magisk-stable-MindTheGapps_2207.40000.8.0_x64_Release-Nightly`or else there will be folder with the `WSA-with-magisk-stable-MindTheGapps_2207.40000.8.0_x64_Release-Nightly`. If there is a folder open it and skip to step 10. NOTE: The name of compressed file or the folder generated in the `output` folder may be different for you. It will be dependent on the choices made when executing `./run.sh`
10. Extract the compressed file and open the folder created after the extraction of the file.
11. Here look for file `Run.bat` and run it.
There is no other variant we can choose.
9. Select the root solution (none means no root).
10. If you are running the script for the first time, it will take some time to complete. After the script completes, two new folders named `output` and `download` will be generated in the `MagiskOnWSALocal` folder. Go to the `output` folder. While running the `./run.sh` script in the step 3, if you selected `Yes` for `Do you want to compress the output?` then in `output` folder you will see a compressed file called `WSA-with-magisk-stable-MindTheGapps_2207.40000.8.0_x64_Release-Nightly`or else there will be folder with the `WSA-with-magisk-stable-MindTheGapps_2207.40000.8.0_x64_Release-Nightly`. If there is a folder open it and skip to step 10. NOTE: The name of compressed file or the folder generated in the `output` folder may be different for you. It will be dependent on the choices made when executing `./run.sh`.
11. Extract the compressed file and open the folder created after the extraction of the file.
12. Here look for file `Run.bat` and run it.
- 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 you have an official WSA installation, you should uninstall it first. (In case you want to preserve your data, you can backup `%LOCALAPPDATA%\Packages\MicrosoftCorporationII.WindowsSubsystemForAndroid_8wekyb3d8bbwe\LocalCache\userdata.vhdx` before uninstallation and restore it after installation.)
- If the popup windows disappear **without asking administrative permission** and WSA is not installed successfully, you should manually run `Install.ps1` as administrator:
1. Press `Win+x` and select `Windows Terminal (Admin)`
- If the popup windows disappear **without asking administrative permission** and WSA is not installed successfully, you should manually run `Install.ps1` as Administrator:
1. Press `Win+x` and select `Windows Terminal (Admin)`.
2. Input `cd "{X:\path\to\your\extracted\folder}"` and press `enter`, and remember to replace `{X:\path\to\your\extracted\folder}` including the `{}`, for example `cd "D:\wsa"`
3. Input `PowerShell.exe -ExecutionPolicy Bypass -File .\Install.ps1` and press `enter`
4. The script will run and WSA will be installed
5. If this workaround does not work, your PC is not supported for WSA
12. Magisk/Play store will be launched. Enjoy by installing LSPosed-zygisk with zygisk enabled or Riru and LSPosed-riru
3. Input `PowerShell.exe -ExecutionPolicy Bypass -File .\Install.ps1` and press `Enter`.
4. The script will run and WSA will be installed.
5. If this workaround does not work, your PC is not supported for WSA.
13. Magisk/Play Store will be launched. Enjoy by installing LSPosed-Zygisk with Zygisk enabled or Riru and LSPosed-Riru.

---

Expand All @@ -96,66 +100,79 @@

- Can I delete the installed folder?

No.
No.

- How can I update WSA to a newer version?

- How can I update WSA to a new version?
1. Update build scripts:

1. Update build scripts
```bash
git pull
```

```bash
git pull
```
For more usage of git, referred to <https://git-scm.com/book>

For more usage of git, referred to <https://git-scm.com/book>
2. Rerun the script, replace the content of your previous installation and rerun `Install.ps1`. Don't worry, your data will be preserved.
2. Rerun the script, replace the content of your previous installation and rerun `Install.ps1`. Don't worry, your data will be preserved.
- How can I get the logcat from WSA?
`%LOCALAPPDATA%\Packages\MicrosoftCorporationII.WindowsSubsystemForAndroid_8wekyb3d8bbwe\LocalState\diagnostics\logcat`
- How can I update Magisk to a new version?
`%LOCALAPPDATA%\Packages\MicrosoftCorporationII.WindowsSubsystemForAndroid_8wekyb3d8bbwe\LocalState\diagnostics\logcat`
Do the same as updating WSA
- How to pass safetynet?
- How can I update Magisk to a newer version?
Do the same as updating WSA.
- How to pass Play Integrity (formerly known as SafetyNet)?
Like all the other emulators, no way.
Like all the other emulators, no way.
- Virtualization is not enabled?
`Install.ps1` helps you enable it if not enabled. After rebooting, rerun `Install.ps1` to install WSA. If it's still not working, you have to enable virtualization in BIOS. That's a long story so ask Google for help.
`Install.ps1` helps you enable it if not enabled. After rebooting, rerun `Install.ps1` to install WSA. If it's still not working, you have to enable virtualization in BIOS. That's a long story so ask Google for help.
- How to remount the system as read-write?
No way in WSA since it's mounted as read-only by Hyper-V. You can modify the system by making a Magisk module. Or directly modify the system.img. Ask Google for help.
- I cannot `adb connect localhost:58526`
No way in WSA since it's mounted as read-only by Hyper-V. You can modify the system by making a Magisk module. Or directly modify the system.img. Ask Google for help.

Make sure developer mode is enabled. If the issue persists, check the IP address of WSA on the setting page and try `adb connect ip:5555`.
- Magisk online module list is empty?
- I cannot `adb connect localhost:58526`, what to do?

Magisk actively removes the online module repository. You can install the module locally or by `adb push module.zip /data/local/tmp` and `adb shell su -c magisk --install-module /data/local/tmp/module.zip`.
- Can I use Magisk 23.0 stable or a lower version?
Make sure developer mode is enabled. If the issue persists, check the IP address of WSA on the setting page and try `adb connect ip:5555`.

- Why the Magisk online module is empty?

Magisk actively removes the online module repository. You can install the module locally or by `adb push module.zip /data/local/tmp` and `adb shell su -c magisk --install-module /data/local/tmp/module.zip`.

- Can I use Magisk v23.0 stable or a lower version?

No. Magisk has bugs preventing itself from running on WSA. Magisk v24+ has fixed them. So you must use Magisk v24 or later.

No. Magisk has bugs preventing itself from running on WSA. Magisk 24+ has fixed them. So you must use Magisk 24 or higher version.
- How can I get rid of Magisk?

Choose `none` as the root solution.
Choose `none` as the root solution.

- How to install custom GApps?

[Tutorial](Custom-GApps.md)
[Tutorial](Custom-GApps.md)

- Where can I download MindTheGapps?

You can download from here [MindTheGapps](https://androidfilehost.com/?w=files&flid=322935) ([mirror](http://downloads.codefi.re/jdcteam/javelinanddart/gapps))
You can download from here [MindTheGapps](https://androidfilehost.com/?w=files&flid=322935) ([mirror](http://downloads.codefi.re/jdcteam/javelinanddart/gapps)).

Note that there is no x86_64 pre-build, so you need to build it by yourself ([Repository](https://gitlab.com/MindTheGapps/vendor_gapps)).
Note that there is no x86_64 pre-build, so you need to build it by yourself ([Repository](https://gitlab.com/MindTheGapps/vendor_gapps)).

Or you can download the built package for 12.1 and 13 for x86_64 from [this page](https://sourceforge.net/projects/wsa-mtg/files/x86_64/).

Or you can download the built package for 12.1 and 13 for x86_64 from [this page](https://sourceforge.net/projects/wsa-mtg/files/x86_64/).
- Can I switch OpenGApps to MindTheGapps and keep user data in a previous build?

No. You should wipe data after changing the GApps brand. Otherwise, you will find that the installed GApps are not recognized.
No. You should wipe data after changing the GApps brand. Otherwise, you will find that the installed GApps are not recognized.

- WSA with OpenGApps integrated fails to start.

OpenGApps has not yet released a version built for Android 12L and 13, only built for Android 11, which may not be compatible and thus cause crashes. Consider switching to MindTheGapps.
OpenGApps has not yet released a version built for Android 12L and 13, only built for Android 11, which may not be compatible and thus cause crashes. Consider switching to MindTheGapps.

- How to install KernelSU?

[Tutorial](KernelSU.md)
[Tutorial](KernelSU.md)

</details>

Expand Down

0 comments on commit a4957ff

Please sign in to comment.