Skip to content

Android.md

Latest commit

 

History

History
159 lines (110 loc) · 3.97 KB

Android.md

File metadata and controls

159 lines (110 loc) · 3.97 KB
label Android (Termux)
route /installation/android-(termux)/

Android (Termux) Installation

SillyTavern can be run natively on Android devices using Termux.

Installing Termux

!!!tip 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. !!!

  1. Download Termux from F-Droid or GitHub releases.

  2. Install the downloaded APK file.

  3. Open Termux and run your first command:

    termux-change-repo

  4. Select "Mirror group" and choose your closest servers. You can touch the screen or use swipe gestures with Unexpected Keyboard.

  5. Update Termux:

    pkg update && pkg upgrade

Installing Dependencies

Install the required packages:

pkg install git nodejs-lts nano

!!!warning 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.

Performance tweaks

!!!info For general tips on improving performance, see the respective FAQ section. !!!

Due to hardware limitations on Android devices, you may want to adjust the following SillyTavern config.yaml settings for better memory, storage, and CPU usage:

performance:
  # Avoid loading all character data until needed
  lazyLoadCharacters: true
  # Disable disk caching to reduce storage usage
  useDiskCache: false
backups:
  chat:
    # Optional: Disable automatic chat backups to save storage
    enabled: false

!!!tip Use the nano text editor included with Termux to edit the config.yaml file: nano ~/SillyTavern/config.yaml !!!

Optional: Create Aliases

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

  1. Open an editor to modify your .bashrc file:

    nano ~/.bashrc

  2. 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'

  3. Save the file and exit the editor (in nano, press CTRL + X, then Y, then Enter).

  4. 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

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