Waydroid: Difference between revisions
imported>Onny mNo edit summary |
|||
(10 intermediate revisions by 6 users not shown) | |||
Line 1: | Line 1: | ||
[https://waydro.id | [https://waydro.id Waydroid] is an application which uses LXC containers to run Android applications on a non-Android system. | ||
{{Warning| | {{Warning|Waydroid requires a Wayland desktop session and cannot be used on X11 directly, but can be run in a nested Wayland session, using e.g. [https://www.hjdskes.nl/projects/cage cage].}} | ||
{{Warning|Installing | {{Warning|Installing Waydroid on your system before running nixos-generate-config will create unnecessary fstab entries that may interfere with system functionality.}} | ||
== Installation == | == Installation == | ||
Enable Waydroid in your system configuration: | |||
{{file|/etc/nixos/configuration.nix|nix|<nowiki> | {{file|/etc/nixos/configuration.nix|nix|<nowiki> | ||
{ | { | ||
virtualisation | virtualisation.waydroid.enable = true; | ||
} | } | ||
</nowiki>}} | </nowiki>}} | ||
After rebuilding and switching, finish the Waydroid install in your shell. | |||
<syntaxhighlight lang=" | <syntaxhighlight lang="console"> | ||
Fetch Waydroid images. | |||
You can add the parameters "-s GAPPS -f" to have GApps support. | |||
sudo waydroid init | $ sudo waydroid init | ||
</syntaxhighlight> | </syntaxhighlight> | ||
Line 38: | Line 29: | ||
Start the container | Start the container | ||
<syntaxhighlight lang=" | <syntaxhighlight lang="console"> | ||
Start the Waydroid LXC container | |||
sudo systemctl start | $ sudo systemctl start waydroid-container | ||
You'll know it worked by checking the journal You should see "Started Waydroid Container". | |||
$ sudo journalctl -u waydroid-container | |||
waydroid session start | |||
Start Waydroid session | |||
You'll know it is finished when you see the message "Android with user 0 is ready". | |||
$ waydroid session start | |||
</syntaxhighlight> | </syntaxhighlight> | ||
General usage | General usage | ||
<syntaxhighlight lang=" | <syntaxhighlight lang="console"> | ||
Start Android UI | |||
waydroid show-full-ui | $ waydroid show-full-ui | ||
waydroid app list | List Android apps | ||
$ waydroid app list | |||
waydroid app launch <application name> | |||
Start an Android app | |||
waydroid app install </path/to/app.apk> | $ waydroid app launch <application name> | ||
sudo waydroid shell | Install an Android app | ||
$ waydroid app install </path/to/app.apk> | |||
waydroid prop set persist.waydroid.width 608 | |||
Enter the LXC shell | |||
$ sudo waydroid shell | |||
Overrides the full-ui width | |||
$ waydroid prop set persist.waydroid.width 608 | |||
</syntaxhighlight> | |||
== Maintenance == | |||
=== Update Android === | |||
Use following command to upgrade Android (LineageOS) to a newer version if available | |||
<syntaxhighlight lang="console"> | |||
$ sudo waydroid upgrade | |||
</syntaxhighlight> | </syntaxhighlight> | ||
Line 71: | Line 78: | ||
<syntaxhighlight lang=" | <syntaxhighlight lang="console"> | ||
Stop Waydroid container | |||
sudo systemctl stop waydroid-container | $ sudo systemctl stop waydroid-container | ||
Removing images and user data | |||
sudo rm -r /var/lib/waydroid/* ~/.local/share/waydroid | $sudo rm -r /var/lib/waydroid/* ~/.local/share/waydroid | ||
</syntaxhighlight> | </syntaxhighlight> | ||
Line 90: | Line 97: | ||
=== Linux 5.18+ === | === Linux 5.18+ === | ||
Linux 5.18 and later removed ashmem in favor of memfd, | |||
Linux 5.18 and later removed ashmem in favor of memfd, so you may need to tell Waydroid (1.2.1 and later) to use the new module: | |||
{{file|/var/lib/waydroid/waydroid_base.prop|prop|<nowiki> | {{file|/var/lib/waydroid/waydroid_base.prop|prop|<nowiki> | ||
sys.use_memfd=true | sys.use_memfd=true | ||
</nowiki>}} | </nowiki>}} | ||
=== Changing keyboard layout === | |||
According to [https://github.com/waydroid/waydroid/issues/209 an upstream issue], changing the keyboard layout doesn't seem possible at the moment. | |||
=== Missing UTF-8 support === | |||
According to [https://github.com/waydroid/waydroid/issues/536 an upstream issue], Android might fail to display special characters correctly. | |||
=== Waydroid interferes with suspend/hybernation === | |||
According to [https://github.com/waydroid/waydroid/issues/168 an upstream issue], Waydroid might interfere with suspend or hybernation. You might have to stop the Android session and container to suspend your machine correctly. | |||
=== Clipboard sharing === | |||
Add <code>wl-clipboard</code> to <code>environment.systemPackages</code>. | |||
==See Also:== | ==See Also:== | ||
* [https://wiki.archlinux.org/title/Waydroid | |||
* [https://wiki.archlinux.org/title/Waydroid Waydroid article on the Archlinux Wiki] |
Latest revision as of 14:36, 3 April 2024
Waydroid is an application which uses LXC containers to run Android applications on a non-Android system.
Installation
Enable Waydroid in your system configuration:
/etc/nixos/configuration.nix
{
virtualisation.waydroid.enable = true;
}
After rebuilding and switching, finish the Waydroid install in your shell.
Fetch Waydroid images.
You can add the parameters "-s GAPPS -f" to have GApps support.
$ sudo waydroid init
Before the following steps, you might need to do some GPU adjustments. See the troubleshooting section.
Usage
Start the container
Start the Waydroid LXC container
$ sudo systemctl start waydroid-container
You'll know it worked by checking the journal You should see "Started Waydroid Container".
$ sudo journalctl -u waydroid-container
Start Waydroid session
You'll know it is finished when you see the message "Android with user 0 is ready".
$ waydroid session start
General usage
Start Android UI
$ waydroid show-full-ui
List Android apps
$ waydroid app list
Start an Android app
$ waydroid app launch <application name>
Install an Android app
$ waydroid app install </path/to/app.apk>
Enter the LXC shell
$ sudo waydroid shell
Overrides the full-ui width
$ waydroid prop set persist.waydroid.width 608
Maintenance
Update Android
Use following command to upgrade Android (LineageOS) to a newer version if available
$ sudo waydroid upgrade
Resetting Android Container
Stop Waydroid container
$ sudo systemctl stop waydroid-container
Removing images and user data
$sudo rm -r /var/lib/waydroid/* ~/.local/share/waydroid
Troubleshooting
GPU Adjustments
In case you have an NVIDIA card or an RX 6800 series, you'll need to disable GBM and mesa-drivers:
/var/lib/waydroid/waydroid_base.prop
ro.hardware.gralloc=default
ro.hardware.egl=swiftshader
Linux 5.18+
Linux 5.18 and later removed ashmem in favor of memfd, so you may need to tell Waydroid (1.2.1 and later) to use the new module:
/var/lib/waydroid/waydroid_base.prop
sys.use_memfd=true
Changing keyboard layout
According to an upstream issue, changing the keyboard layout doesn't seem possible at the moment.
Missing UTF-8 support
According to an upstream issue, Android might fail to display special characters correctly.
Waydroid interferes with suspend/hybernation
According to an upstream issue, Waydroid might interfere with suspend or hybernation. You might have to stop the Android session and container to suspend your machine correctly.
Clipboard sharing
Add wl-clipboard
to environment.systemPackages
.