Skip to content

Latest commit

 

History

History
244 lines (186 loc) · 8.29 KB

README.md

File metadata and controls

244 lines (186 loc) · 8.29 KB


Easily Install Termux GUI Desktop

GitHub stars GitHub forks GitHub issues GitHub repo size GitHub License


Key Features:

  • 📚 Quick Setup: Easy-to-follow installation process.
  • 🖥️ Desktop Styles: Supports XFCE, LXQt, and OPENBOX with beautiful themes.
  • 🍷 Windows App Support: Run Windows apps using Wine (x86_64 on ARM64 devices).
  • 🦾 Hardware Acceleration: Enhances performance for supported hardware.
  • 🖇️ GUI Access: Supports Termux:X11 and VNC.
  • 📦 Package Management: Compatible with both APT and PACMAN.
  • 🧩 One-Click App Installation:
    • Browsers: Firefox, Chromium
    • Code Editors: VS Code, Geany
    • Image Editors: GIMP, Inkscape
    • And more...
  • 📦 Additional Apps: Install apps like LibreOffice not available by default in Termux.
  • 🎨 Customizations: Extensive configuration options to suit user preferences.

Getting Started:

1. Ensure Requirements Are Met:
  • Android 8+ device

  • Termux (download from GitHub or F-Droid)

    NOTE: This Only Works On Termux From Github Or Fdroid

    Avoid using Termux from Google Play due to API limitations.

  • Minimum 2GB of RAM (3GB recommended)

  • 1.5-2GB of Internet data

  • 3-4GB of free storage

  • VNC Client (RealVNC or NetHunter Kex)

  • Termux:X11

  • Termux-API (Openbox only)

2. Explore Desktop Styles:
3. Hardware Acceleration and Distro Container:
4. View Supported Apps:
  • Full list available here.
5. Start Installation:

Note: Fresh installations are recommended for best results.

Note: If you are in android 12 or higher then first disable Phantom Process Killer Guide:- Here

curl -Lf https://raw.githubusercontent.com/sabamdarif/termux-desktop/main/setup-termux-desktop -o setup-termux-desktop && chmod +x setup-termux-desktop && ./setup-termux-desktop
6. Usage Instructions:
  • Commands for starting and stopping Termux:X11 and VNC sessions are provided below.

Command Reference:

Start Termux:X11

tx11start [options]

Options:

  • --nogpu: Disable GPU acceleration.
  • --legacy: Enable legacy drawing.
  • --nodbus: Disable DBus.
  • Combine options for specific configurations (e.g., tx11start --nogpu --legacy).
  • --help: To show help.
Example:
  • tx11start to star Termux:11 with gpu acceleration
  • tx11start --nogpu to star Termux:11 without gpu acceleration
  • tx11start --nogpu --legacy to star Termux:11 without gpu acceleration and -legacy-drawing
  • tx11start --nodbus to star Termux:11 without dbus
  • tx11start --nodbus --nogpu to star Termux:11 without gpu acceleration and dbus
  • tx11start --nodbus --nogpu --legacy to star Termux:11 without gpu acceleration and dbus and with -legacy-drawing
  • tx11start --nodbus --legacy to star Termux:11 without dbus and use -legacy-drawing (nodbus and gpu)
  • tx11start --legacy to star Termux:11 with -legacy-drawing (with dbus and gpu)
  • tx11start --debug --OTHER-PARAMETERS To see log of that commmand

    tx11start --debug --nogpu To See tx11start --nogpu's log

Stop Termux:X11

tx11stop [-f]

Options:

  • -f: Force stop.
  • --help: To show help.

Start VNC

vncstart [options]

Options:

  • --nogpu: Disable GPU acceleration.
  • --help: To show help.

Stop VNC

vncstop [-f]

Options:

  • -f: Force stop.
  • --help: To show help.

GUI Commands

gui [options]

Options:

  • --start: Start GUI (use vnc or tx11 as arguments).
  • --stop: Stop GUI.
  • --kill: Stop all GUI sessions.
  • --help: To show help.
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
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

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.
  • --help: To show help.
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 --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 --debug (At The Start) To generate a log file for any of the above command

    • setup-termux-desktop --debug --install To create a log of whole installation process

Screenshots:

Demo Looks

XFCE LXQT
img img
OPENBOX MATE
img img

Browsers:

Firefox and Chromium

Image Editors:

Inkscape and GIMP

Code Editors:

Geany and VS Code

Media Players:

Parole and VLC


Advanced Topics:

Wine:

Run Windows applications seamlessly. Learn more here.

Distro Containers:

Install additional apps like LibreOffice. Details here.

Hardware Acceleration:

Enhance performance with GPU acceleration. Learn more here.


Acknowledgments:

Special thanks to:


If you enjoy this project, consider giving it a star! 🌟

Join the conversation: Telegram Chat.