SteamOS Android Waydroid Installer

A shell script to easily install / uninstall Android (via Waydroid) on the Steam Deck running on SteamOS.

NOTE
If you are going to use this script for a video tutorial, PLEASE reference on your video where you got the script! This will make the support process easier! And don't forget to give a shoutout to @10MinuteSteamDeckGamer / ryanrudolf from the Philippines!

If you like my work please show support by subscribing to my YouTube channel @10MinuteSteamDeckGamer.
I'm just passionate about Linux, Windows, how stuff works, and playing retro and modern video games on my Steam Deck!

Monetary donations are also encouraged if you find this project helpful. Your donation inspires me to continue research on the Steam Deck! Clover script, 70Hz mod, SteamOS microSD, Secure Boot, etc.

Scan the QR code or click the image below to visit my donation page.

Disclaimer

1. Do this at your own risk!
2. This is for educational and research purposes only!

Video Tutorial - SteamOS Android Waydroid Installer

Click the image below for a video tutorial and to see the functionalities of the script!

What's New (as of April 25 2024)

1. This works with latest stable SteamOS 3.5.19. There is no kernel change for SteamOS - it still uses 6.1.52-valve16-1 so this works right away no need for new kernel modules.
   SteamOS has been stuck on 6.1.52-valve16-1 for several releases now so I think this will stay and next major bump will be on SteamOS 3.6.x.

What's New (as of March 09 2024)

1. Updated launcher to easily run APKs in Game Mode. demo guide here
2. Fix minor typo in uninstall - this now removes the Waydroid application entries in the KDE menu.
3. Added Waydroid Toolbox to easily configure some aspects of Waydroid.

What's New (as of February 11 2024)

1. Added support for latest SteamOS Preview 3.5.15 - kernel 6.1.52-valve16-1-neptune-61

What's New (as of February 10 2024)

1. lower audio latency
2. added more sanity checks

What's New (as of February 07 2024)

1. removed weston. been testing cage for several weeks now and this is way better than weston.
2. added custom hosts file to block ads

Click here to view previous CHANGELOGS

Install Steps

Read the sections below carefuly!

Prerequisites for SteamOS

1. sudo password should already be set by the end user. If sudo password is not yet set, the script will ask to set it up.

NOTE IF YOU ARE USING AN OLDER VERSION OF MY SCRIPT FROM 2023!

1. Uninstall first if you are using an older version from 2023.
2. If you are using my script from 2024 onwards no need to uninstall - just clone the repo to get the latest version and install it.

How to Use

1. Go into Desktop Mode and open a konsole terminal.
2. Clone the github repo.
   cd ~/
   git clone https://github.com/ryanrudolfoba/steamos-waydroid-installer
3. Execute the script!
   cd ~/steamos-waydroid-installer
   chmod +x steamos-waydroid-installer.sh
   ./steamos-waydroid-installer.sh
4. Script will automatically install Waydroid together with the custom config. Install will roughly take around 5mins depending on the internet connection speed.
5. Once done exit the script and go back to Game Mode.

Launching Waydroid

1. Go to Game Mode.
2. Run the Android_Waydroid_Cage launcher.

I dont want this anymore! I want to uninstall!

1. Go to Desktop Mode.
2. There will be an icon called Waydroid Toolbox on the desktop.
3. Launch that icon and select UNINSTALL.

Troubleshooting / Filing Bug Reports

1. If you encounter an issue with the script, try to uninstall, clone the repo again and perform an install.
   Reason for that - you might be using an older version of my script and a new version might have already fixed your issue.
2. If uninstall / reinstall didn't help, open an issue and please be descriptive as possible.
   At the minimum include this when filing an issue -
   SteamOS version -
   Error message encountered -
   Screenshot of error -
   Do you have any scripts / tweaks that might be causing issues?
3. Downloads are slow when acquiring the waydroid image. This is similar to this issue.
   Answer - You might have connected to a slow sourceforge mirror. Press CTRL-C to cancel the download and re-run the script again.
4. No shortcuts in Game Mode after running the script / Unsupported File Type when adding shortcuts. This is similar to this issue.
   Answer - This issue happens if Steam client cant be run because the script was called from an ssh or virtual tty session. Make sure to run the script on Desktop Mode via konsole.

A Note on SteamOS Updates

When there is a SteamOS update the waydroid will be wiped. This is normal behavior due to how SteamOS applies updates.
Re-run the script again but if the SteamOS update contains a new kernel version the script will exit immediately.
Please file an issue report when this happens so I can compile a binder kernel module to match the SteamOS update.

Geekbench Benchmark Result Between OLED and LCD on SteamOS Android Waydroid

Geekbench Result - Feb 11 2024

List of Games Tested Working with Demo Gameplay

This is a Work in Progress - list will be updated accordingly.
If you wish to contribute, please check the google sheets and include the game name, how it runs etc etc.

Games Tested By Me on Android Waydroid Steam Deck

Plants vs Zombies - Feb 04 2024
Honkai Star Rail - Feb 06 2024
Asphalt 8 Airborne - Feb 08 2024
Honkai Impact 3rd - Feb 10 2024
Mobile Legends - Feb 13 2024
T3 Arena - Feb 16 2024
Warcraft Rumble - Feb 19 2024
Diablo Immortal - Feb 21 2024
Oceanhorn - Feb 23 2024
Candy Crush Saga - Mar 11 2024
BombSquad - Mar 16 2024
Project BloodStrike - Mar 18 2024
NBA Infinite - Mar 23 2024

Games Tested by Other Users

Please check this google sheets for games tested by other users.
Please feel free to add your game testing in there too! Thank you!

Mini-guides for Steam Deck Android Waydroid

This mini guides are tailor-fitted for the Steam Deck that uses the script provided in this repo.
How to Sideload APKs
How to Upgrade the Android Image
How to Configure Fake Wi-Fi
How to Configure Fake Touchscreen / Configure Mouse Clicks as Touchscreen Input
How to Launch APKs Directly in Game Mode
Configure for 1080p When in Docked Mode
Configure sdcard as Main Storage for Waydroid
Activate and Configure Mantis Gamepad Pro