https://github.com/rikj000/xwaydroid
XWaydroid, the Waydroid launcher tool to improve the user experience of KDE / X-Server users!
https://github.com/rikj000/xwaydroid
android kde launcher linux wayland x-server
Last synced: about 1 year ago
JSON representation
XWaydroid, the Waydroid launcher tool to improve the user experience of KDE / X-Server users!
- Host: GitHub
- URL: https://github.com/rikj000/xwaydroid
- Owner: Rikj000
- License: gpl-3.0
- Created: 2023-11-05T20:03:29.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2023-11-05T20:37:51.000Z (over 2 years ago)
- Last Synced: 2025-04-07T16:52:39.823Z (about 1 year ago)
- Topics: android, kde, launcher, linux, wayland, x-server
- Language: Shell
- Homepage:
- Size: 16.6 KB
- Stars: 16
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: ReadMe.md
- License: LICENSE
Awesome Lists containing this project
README
# XWaydroid
XWaydroid, the Waydroid launcher tool to improve the user experience of KDE / X-Server users!
## Note-able Features
- Directly launch the full `waydroid` UI in a `wayland` session window
- Directly launch `waydroid` apps in a `wayland` session window
- Easily patch all your `waydroid.*.desktop` files,
to directly launch in a `wayland` session window through `xwaydroid`!
## Dependencies
XWaydroid requires the following dependencies to work properly,
installation of these is out of the scope of this guide.
- [Waydroid](https://github.com/waydroid/waydroid) *(Guide assumes `waydroid-container.service` has been enabled)*
- [KWin_Wayland](https://community.kde.org/KWin/Wayland)
- [ADB](https://developer.android.com/tools/adb)
## Installation
1. Download the latest [XWaydroid](https://github.com/Rikj000/XWaydroid/releases) release
2. Unzip it somewhere (e.g. `/home//Documents/XWaydroid/>`)
3. Create a symbolic link to `/usr/bin/xwaydroid`:
```bash
# Alter !
sudo ln -s /home//Documents/XWaydroid/xwaydroid.sh /usr/bin/xwaydroid
```
## Updates
1. Download the latest [XWaydroid](https://github.com/Rikj000/XWaydroid/releases) release.
2. Unzip it to the previous installation location (default. `/home//Documents/XWaydroid/>`)
## Usage
```bash
Usage:
xwaydroid [options]
Example:
xwaydroid --app=com.android.calculator2
Optional-Arguments:
| Shorthand | Full notation | Description |
| --------------------- | ------------------------------------- | ----------------------------------------------------------------- |
| -h | --help | Show this help. |
| -v | --version | Show the currently installed XWaydroid version number |
| -a= | --app= | Name of the Waydroid app to open, defaults to: '' (show-full-ui) |
| -l | --list | Lists all names of installed app. (Waydroid must be running) |
| -pdf | --patch-desktop-files | Patches all the |
| | | "/home//.local/share/applications/waydroid.*.desktop" |
| | | files, to automatically launch through XWaydroid. |
| -wb= | --waydroid-bin= | Path to the Waydroid binary, defaults to: 'waydroid' |
| -wwb= | --wayland-window-bin= | Path to the Wayland window, defaults to: 'kwin_wayland' |
| | | Others not yet supported. |
| -www= | --wayland-window-width= | Pixel width of the Wayland window, defaults to: 3440 |
| -wwh= | --wayland-window-height= | Pixel height of the Wayland window, defaults to: 1340 |
```
## Notes
- Please be patient when starting the first `waydroid` app through `xwaydroid`.
A black `kwin_wayland` window for a few minutes, before you see the LineageOS loading logo, is normal.
- If switching between `waydroid` apps through `xwaydroid`, it's recommended to leave the `kwin_wayland` window open.
Closing / re-opening the `kwin_wayland` window leads to a "reboot" of the `waydroid` session which takes a while.
Leaving the `kwin_wayland` window, leads to instant startup of new `waydroid` apps.
- Opening / using multiple `waydroid` apps through `xwaydroid` is supported, albeit through a single `kwin_wayland` window.
- The default values of some optional-options,
can be configured in the `Default Settings` section at the start of the `xwaydroid` script.