91 lines
3.7 KiB
Markdown
91 lines
3.7 KiB
Markdown
# Roid: an easy Void Linux installation toolkit for Termux environments on top of Android OS
|
|
|
|
The Roid toolkit allows you to turn any Android device that can run Termux (and Termux-X11, if you need a GUI desktop) into a full-featured [Void Linux](https://voidlinux.org/) PC.
|
|
|
|
Only tested on ARM64. Other hardware platforms may or may not work.
|
|
|
|
## Features
|
|
|
|
* Full (glibc-based) Void Linux installation for your smartphone/tablet architecture (usually ARM64)
|
|
* Convenient shell aliases inside the environment (see [.roidrc](.roidrc))
|
|
* Sound support out of the box (via PulseAudio)
|
|
* A set of development tools out of the box (GCC, Make, Autotools, Perl, Tcl, Python, Janet, S-Lang, Lua, Expect etc)
|
|
* (Opt-out) 3D-accelerated X11 GUI desktop environment (i3, st-sx, Fira Code, Noto Fonts etc)
|
|
|
|
## Prerequisites
|
|
|
|
* Android 8 or later.
|
|
* [Termux](https://termux.dev/en/) installed and prepared with `termux-change-repo` and `termux-setup-storage`. It's also strongly recommended to select "Acquire wakelock" in the notification bar before starting the installation.
|
|
* [Termux-X11](https://github.com/termux/termux-x11) installed from GH releases in case you need a GUI desktop. **Note**: not all Android flavors are supported by Termux-X11.
|
|
* Git installed within Termux itself: `pkg updrade -y && pkg install -y git`
|
|
|
|
## Installation
|
|
|
|
Run from within the Termux shell:
|
|
|
|
```sh
|
|
git clone --depth 1 https://codeberg.org/luxferre/roid.git ~/roid
|
|
sh ~/roid/install
|
|
```
|
|
|
|
In case you don't need a GUI desktop, run `NOX=y sh ~/roid/install` instead.
|
|
|
|
After the process completes, you need to fully exit the Termux shell and re-enter it before you can start Void.
|
|
|
|
## Absolute minimum installation (no Git required on Termux side)
|
|
|
|
```sh
|
|
curl -sSL https://luxferre.top/roid.sh | sh
|
|
```
|
|
|
|
The [roid.sh](roid.sh) script installs a near-barebones, CLI-only, but still convenient Void Linux environment and also updates your Termux font to Fira Code Retina in order to enable ligatures. It uses a separate `.roidrc` file that's stored as [.roidrc-minimal](.roidrc-minimal) in this repo.
|
|
|
|
This is the author's preferred way of quickstarting a Void shell on any fresh device running Termux.
|
|
|
|
## CLI usage
|
|
|
|
From the Termux environment, just type `void` to enter the Void Linux shell. You're ready to go. Your original Termux home path is available in the `$TERMUX_HOME` environment variable.
|
|
|
|
Alternatively, if you don't want to enter the shell but just run a command inside Void Linux and then return to Termux, type `voidrun [command]` instead.
|
|
|
|
## Desktop GUI usage (requires Termux-X11)
|
|
|
|
1. Open Termux-X11 in the background.
|
|
2. Switch to Termux (make sure the wakelock is on!) and type `voidgui` to enter the shell.
|
|
3. Switch to Termux-X11 to start using the environment.
|
|
4. Exit both the desktop and the CLI shell with Mod4+Shift+E.
|
|
|
|
Alternatively, you can run `startx` (here, it's an alias) from your CLI environment and proceed as usual.
|
|
|
|
Having at least an external keyboard connected to your device is highly recommended for better desktop experience.
|
|
|
|
After exiting the Void Linux shell and before exiting Termux, it's advisable to run the `roidclean` command to stop the PulseAudio and 3D acceleration servers.
|
|
|
|
## Uninstallation
|
|
|
|
To fully uninstall Void Linux set up by Roid, exit the Void shell and then run either this:
|
|
|
|
```
|
|
roidclean
|
|
pd remove void-glibc-full
|
|
sed -i '/ROID_INST/d' ~/.profile
|
|
sed -i '/ROID_INST/d' ~/.bashrc
|
|
pkg remove -y proot-distro pulseaudio x11-repo termux-x11-nightly virglrenderer-android
|
|
apt autoremove -y
|
|
exit
|
|
```
|
|
|
|
or this (if you still have the original `~/roid` directory in place):
|
|
|
|
```
|
|
sh ~/roid/uninstall
|
|
rm -rf ~/roid
|
|
exit
|
|
```
|
|
|
|
Upon re-entering the Termux shell, no traces of the installation should be found.
|
|
|
|
## Credits
|
|
|
|
Created by Luxferre in 2026, released into the public domain with no warranties.
|