Update README.md

This commit is contained in:
deffcolony
2024-03-17 21:33:14 +01:00
committed by GitHub
parent 3c6e2ec2c6
commit 329d212d4f

View File

@@ -1,8 +1,22 @@
# SillyTavern-Launcher
Launcher scripts for SillyTavern and Extras.
<a name="readme-top"></a>
## Usage
### Windows
<div align="center">
<img height="160" src="https://github.com/SillyTavern/SillyTavern-Launcher/assets/61471128/129e2b39-6c62-4e67-9ba3-79876069b0e4">
<h1 align="center">SillyTavern Launcher - (STL)</h1>
<p align="center">
【English | <a href="README-zh-cn.md">Chinese</a> | <a href="README-ja-jp.md">Japanese</a> | <a href="README-ko-kr.md">Korean</a> | <a href="README-nl-nl.md">Dutch</a> | <a href="README-fr-fr.md">French</a> | <a href="README-vi-vn.md">Vietnamese</a> | <a href="README-pt-pt.md">Portuguese</a> | <a href="README-es-es.md">Spanish</a>】
[![GitHub Stars](https://img.shields.io/github/stars/SillyTavern/SillyTavern-Launcher.svg)](https://github.com/SillyTavern/SillyTavern-Launcher/stargazers)
[![GitHub Forks](https://img.shields.io/github/forks/SillyTavern/SillyTavern-Launcher.svg)](https://github.com/SillyTavern/SillyTavern-Launcher/network)
[![GitHub Issues](https://img.shields.io/github/issues/SillyTavern/SillyTavern-Launcher.svg)](https://github.com/SillyTavern/SillyTavern-Launcher/issues)
[![GitHub Pull Requests](https://img.shields.io/github/issues-pr/SillyTavern/SillyTavern-Launcher.svg)](https://github.com/SillyTavern/SillyTavern-Launcher/pulls)
</div>
## 🔧 Installation
### 🪟 Windows
1. Install [Git for Windows](https://gitforwindows.org/)
2. Open Windows Explorer (`Win+E`) and make or choose a folder where you wanna install the launcher to
3. Open a Command Prompt inside that folder by clicking in the 'Address Bar' at the top, typing `cmd`, and pressing Enter.
@@ -10,17 +24,38 @@ Launcher scripts for SillyTavern and Extras.
5. double click on `installer.bat` and choose what you wanna install
6. After installation double click on `launcher.bat`
### Linux
### 🐧 Linux
1. Open your favorite terminal and install git
2. Download Sillytavern Launcher with: `git clone https://github.com/SillyTavern/SillyTavern-Launcher.git`
3. Navigate to the SillyTavern-Launcher with: `cd SillyTavern-Launcher`
4. Start the install launcher with: `chmod +x install.sh && ./install.sh` and choose what you wanna install
5. After installation start the launcher with: `chmod +x launcher.sh && ./launcher.sh`
### Mac
### 🍎 Mac
1. Open a terminal and install brew with: `/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"`
2. Then install git with: `brew install git`
3. Download Sillytavern Launcher with: `git clone https://github.com/SillyTavern/SillyTavern-Launcher.git`
4. Navigate to the SillyTavern-Launcher with: `cd SillyTavern-Launcher`
5. Start the install launcher with: `chmod +x install.sh && ./install.sh` and choose what you wanna install
6. After installation start the launcher with: `chmod +x launcher.sh && ./launcher.sh`
6. After installation start the launcher with: `chmod +x launcher.sh && ./launcher.sh`
## ✨ Features
* Automatic installation of the following:
* SillyTavern
* Extras
* XTTS
* Auto update all apps
* Backup and Restore SillyTavern
* Switch branch
* Module editors
* App installer & uninstaller to manage applications
* Troubleshooting menu to fix most common problems
Installer:
![image](https://github.com/SillyTavern/SillyTavern-Launcher/assets/61471128/91db3d97-65a6-45be-a2f3-6c90a99963d0)
Launcher:
![image](https://github.com/SillyTavern/SillyTavern-Launcher/assets/61471128/24bced5e-da74-4e8c-94f6-f1366ef8e871)