# Android (Termux) Installation

SillyTavern can be run natively on Android devices using Termux.

# Installing Termux

Avoid installing Termux from the Google Play Store, that version is no longer maintained. Instead, use F-Droid (recommended) or GitHub releases to get the latest version.

Download Termux from F-Droid or GitHub releases.
Install the downloaded APK file.
Open Termux and run your first command:
```
termux-change-repo
```
Select "Mirror group" and choose your closest servers. You can touch the screen or use swipe gestures with Unexpected Keyboard.
Update Termux:
```
pkg update && pkg upgrade
```

# Installing Dependencies

Install the required packages:

pkg install git nodejs-lts nano

If you're running 32-bit Android, see the Common Errors section below for additional steps.

# Installing SillyTavern

Clone the SillyTavern repository (How to Choose a Branch):

Release Branch:

git clone https://github.com/SillyTavern/SillyTavern -b release

Staging Branch:

git clone https://github.com/SillyTavern/SillyTavern -b staging

# Running SillyTavern

To run SillyTavern, navigate to the cloned directory and run the start script:

cd ~/SillyTavern
bash start.sh

To update SillyTavern, navigate to the SillyTavern directory and run:

cd ~/SillyTavern
git pull --rebase --autostash

See the Aliases section below for creating shortcuts to simplify this process.

# Common Errors

# Unsupported platform: android arm LEtime-web

32-bit Android requires an external dependency that can't be installed with npm.

Use the following command to install it:

pkg install esbuild

Then proceed with the installation steps above.

# Optional: Create Aliases

You can create shortcuts for common commands to make your workflow easier.

Open an editor to modify your .bashrc file:
```
nano ~/.bashrc
```

Add the following lines to create aliases:

# Update Termux packages
alias pkgup="pkg update && pkg upgrade"
#Start SillyTavern
alias st='cd ~/SillyTavern && bash start.sh'
# Update SillyTavern
alias stup='cd ~/SillyTavern && git pull --rebase --autostash'

Save the file and exit the editor (in nano, press CTRL + X, then Y, then Enter).
To apply the changes, run:
```
source ~/.bashrc
```

Now you can use the following commands:

st to start SillyTavern
stup to update SillyTavern
pkgup to update Termux packages

# Further Reading

The guides linked below are not maintained by the SillyTavern team.

SillyTavern in Termux guide by ArroganceComplex#2659: https://rentry.org/STAI-Termux
Accessing Termux files with Material Files: https://www.learntermux.tech/2020/10/Termux-File-Manager.html
Prevent Termux process deep sleep: https://wiki.termux.com/wiki/Termux-wake-lock