# Termux Desktop
#### Easily Install Termux Native GUI Desktop
   
Key Features:
- :books: Easy Setup: Easy-to-follow installation process
- :desktop_computer: Desktop Styles: Supports Xfce, LXQt, and Openbox... others with beautiful themes
- :mechanical_arm: Hardware Acceleration: It will install all the drivers in order to get hardware acceleration working under termux
- :paperclips: GUI Access:
- Termux:X11 (Default)
- VNC (optional and only available if you chose
custom during the setup)
- :package: Package Management:
- APT (Termux's default and recommended)
- PACMAN (pacman may be buggy, not well tested)
- :shopping: App Store: An appstore to install apps
- :package: Container It lets you use a proot/chroot distro as a container to install more apps than Termux normally supports
- And a lot more, try it
Quick Navigation:
**:package: [Distro Containers](https://github.com/sabamdarif/termux-desktop/blob/HEAD/docs/proot-container.md) • :mechanical_arm: [Hardware Acceleration](https://github.com/sabamdarif/termux-desktop/blob/HEAD/docs/hw-acceleration.md) • :wine_glass: [Wine](https://github.com/sabamdarif/termux-desktop/blob/HEAD/docs/wine.md#wine_glasslearn-about-wine) • :bulb: [Others](https://github.com/sabamdarif/termux-desktop/blob/HEAD/docs/see-more.md)**
Getting Started:
1. Ensure Requirements Are Met:
[!NOTE]
This Only Works On Termux From GitHub Or F-Droid.
Avoid using Termux from Google Play that doesn't work due to API limitations.
2. Currently supported Desktop Environments and Window Managers:
[!TIP]
Click on the Blue links to see all the available Styles for that De/Wm
| Desktop Environments |
Window Managers |
| Xfce |
Openbox |
| LXQt |
i3 |
| MATE |
dwm |
| GNOME |
bspwm |
| Cinnamon |
Awesome |
| KDE Plasma |
Fluxbox |
|
IceWM |
|
WMaker |
3. Start Installation:
[!TIP]
Fresh installations are recommended for best results.
[!IMPORTANT]
$\textsf{\color{#d73a49}{ANDROID 12+ USERS}}$
Disable Phantom Process Killer before installation. Learn how
One Liner:
bash <(curl -Lf https://raw.githubusercontent.com/sabamdarif/termux-desktop/main/setup-termux-desktop)
Or:
- Link shortened using open source link shortener: https://kutt.to/
bash <(curl -Lf kutt.to/setup-termux-desktop)
[!TIP]
You can also do a lite install which will not install all the optional packages. To do that, first run export LITE=true or export LITE=1, then run the installer
🎥 Video Tutorial
Full Installation Guide: Watch on YouTube
4. Usage Instructions:
- Commands for starting and stopping Termux:X11 and VNC sessions are provided below.
Command Reference:
Start Termux:X11
tx11start [options]
Options:
--xstartup: Start the user-specified xstartup.--nogpu: Disable GPU acceleration.--legacy: Enable legacy drawing.- Combine options for specific configurations (e.g.,
tx11start --nogpu --legacy).
--help: Show help.
Full Example:
- `tx11start` _to start Termux:X11 with gpu acceleration_
- `tx11start --xstartup cinnamon-session` _to start cinnamon even if you setup with xfce or anything else_
- `tx11start --nogpu` _to start Termux:X11 without gpu acceleration_
- `tx11start --nogpu --legacy` _to start Termux:X11 without gpu acceleration and *-legacy-drawing*_
- `tx11start --legacy` _to start Termux:X11 with *-legacy-drawing* (with gpu)_
- `tx11start --debug --OTHER-PARAMETERS` _To see log of that command_
> tx11start --debug --nogpu _To see tx11start --nogpu's log_
Stop Termux:X11
tx11stop [-f]
Options:
-f: Force stop.--help: Show help.
Start VNC
vncstart [options]
Options:
--nogpu: Disable GPU acceleration.--help: Show help.
Stop VNC
vncstop [-f]
Options:
-f: Force stop.--help: Show help.
GUI Commands
gui [options]
Options:
--start: Start GUI (use vnc or tx11 as arguments).--display: Launch the current desktop environment on another X11 display server over the same network.--stop: Stop GUI.--kill: Stop all GUI sessions.--help: Show help.
Full Example:
##### If you select only one of them to access gui
- `gui --start / gui -l` _to start Termux gui_
- `gui --stop / gui -s` _to stop gui_
- `gui --display / gui -d` `:` _To launch the current desktop environment on another X11 display server over the same network_
##### If you select both for gui access
- `gui -l / --start` `vnc` _to start VNC_
- `gui -l / --start` `tx11` _to start Termux:X11_
- `gui -s / --stop` `vnc` _to stop VNC_
- `gui -s / --stop` `tx11` _to stop Termux:X11_
- `gui -k / --kill / -kill` _to kill both vncserver and Termux:x11 At Once_
- `gui --display / gui -d` `:` _To launch the current desktop environment on another X11 display server over the same network_. For more click :- [Here](https://github.com/sabamdarif/termux-desktop/blob/main/docs/see-more.md#hammer_and_wrenchhow-to-use-x11-display-forwarding-option)
Setup Commands
setup-termux-desktop [options]
Options:
--change style: Change desktop style.--change hw: Modify hardware acceleration settings.--reset: Reset all changes.--remove: Uninstall Termux Desktop.--local-config: Start the installation from a pre-made config file.--help: Show help.
Full Example:
- `setup-termux-desktop --change style` _To Change Desktop Style_
- `setup-termux-desktop --change hw` _To Change Hardware Acceleration Method_
- `setup-termux-desktop --change pd` _To Change Installed Proot-Distro_
- `setup-termux-desktop --change autostart` _To change autostart behaviour_
- `setup-termux-desktop --change display` _To change termux:x11 display port_
- `setup-termux-desktop --change de` _To switch between different desktop environment or window manager_
- `setup-termux-desktop --reinstall icons / themes /config` _To Reinstall Icons / Themes / Config_
- `setup-termux-desktop --reinstall icons,themes,..etc` _To Reinstall Them At Once_
- `setup-termux-desktop --reset` _To Reset All Changes Made By This Script Without Uninstalling The Packages_
- `setup-termux-desktop --remove / -r` _To Remove Termux Desktop_
- `setup-termux-desktop --local-config / -config` _Start the installation from a pre-made config file_ > Each time you install the desktop environment or make some changes using the script it writes all your config to the `/data/data/com.termux/files/usr/etc/termux-desktop/configuration.conf` file. Copy that somewhere else, so next time when you want to install the desktop environment with that old config all you have to do is `setup-termux-desktop --local-config /path/to/configuration.conf`
- `setup-termux-desktop --debug` **(At the start)** _To generate a log file for any of the above commands_
- `setup-termux-desktop --debug --install` _To create a log of whole installation process_
Associated Repos:
📜 License
This project is licensed under the GNU General Public License v3.0
Copyright (C) 2024 sabamdarif
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
Acknowledgments:
Special thanks to:
If you enjoy this project, consider giving it a star! :star2:
Support the Project
If you find Termux Desktop useful and would like to support its development, consider buying me a coffee! Your support helps me maintain and improve this project.
- USDT (BEP20,ERC20):-
0x1d216cf986d95491a479ffe5415dff18dded7e71
- USDT (TRC20):-
TCjRKPLG4BgNdHibt2yeAwgaBZVB4JoPaD
- BTC:-
13Q7xf3qZ9xH81rS2gev8N4vD92L9wYiKH
- DOGE (dogecoin):-
DJkMCnBAFG14TV3BqZKmbbjD8Pi1zKLLG6
- ETH (ERC20):-
0x1d216cf986d95491a479ffe5415dff18dded7e71
Every contribution, no matter how small, helps keep this project alive and growing! ❤️