Update README

e8b54cc8f0c755558cd33953c069202844019462

Cohee <18619528+Cohee1207@users.noreply.github.com>

1 files changed, +3 -42Ignore whitespace
.github/readme.md+3 -42
@@ -42,7 +42,7 @@ If you're not familiar with using the git CLI or don't understand what a branch
4242
43## What do I need other than SillyTavern?43## What do I need other than SillyTavern?
4444
45Since SillyTavern is only an interface, you will need access to an LLM backend to provide inference. You can use AI Horde for instant out-of-the-box chatting. Aside from that, we support many other local and cloud-based LLM backends: OpenAI-compatible API, KoboldAI, Tabby, and many more. You can read more about our supported APIs in [the FAQ](https://docs.sillytavern.app/usage/api-connections/).45Since SillyTavern is only an interface, you will need access to an LLM backend to provide inference. You can use AI Horde for instant out-of-the-box chatting. Aside from that, we support many other local and cloud-based LLM backends: OpenAI-compatible API, KoboldAI, Tabby, and many more. You can read more about our supported APIs in [the Docs](https://docs.sillytavern.app/usage/api-connections/).
4646
47### Do I need a powerful PC to run SillyTavern?47### Do I need a powerful PC to run SillyTavern?
4848
@@ -83,9 +83,7 @@ Or get in touch with the developers directly:
8383
84SillyTavern is built around the concept of "character cards". A character card is a collection of prompts that set the behavior of the LLM and is required to have persistent conversations in SillyTavern. They function similarly to ChatGPT's GPTs or Poe's bots. The content of a character card can be anything: an abstract scenario, an assistant tailored for a specific task, a famous personality or a fictional character.84SillyTavern is built around the concept of "character cards". A character card is a collection of prompts that set the behavior of the LLM and is required to have persistent conversations in SillyTavern. They function similarly to ChatGPT's GPTs or Poe's bots. The content of a character card can be anything: an abstract scenario, an assistant tailored for a specific task, a famous personality or a fictional character.
8585
86The name field is the only required character card input. To start a neutral conversation with the language model, create a new card simply called "Assistant" and leave the rest of the boxes blank. For a more themed chat, you can provide the language model with various background details, behavior and writing patterns, and a scenario to jump start the chat.86To have a quick conversation without selecting a character card or to just test the LLM connection, simply type your prompt input into the input bar on the Welcome Screen after opening SillyTavern. This will create an empty "Assistant" character card that you can customize later.
87
88To have a quick conversation without selecting a character card or to just test the LLM connection, simply type your prompt input into the input bar on the Welcome Screen after opening SillyTavern. Please note that such chats are temporary and will not be saved.
8987
90To get a general idea on how to define character cards, see the default character (Seraphina) or download selected community-made cards from the "Download Extensions & Assets" menu.88To get a general idea on how to define character cards, see the default character (Seraphina) or download selected community-made cards from the "Download Extensions & Assets" menu.
9189
@@ -316,18 +314,6 @@ chmod +x launcher.sh && ./launcher.sh
316314
317**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 run the usual installation steps.315**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 run the usual installation steps.
318316
319## API keys management
320
321SillyTavern saves your API keys to a `secrets.json` file in the user data directory (`/data/default-user/secrets.json` is the default path).
322
323By default, API keys will not be visible from the interface after you have saved them and refreshed the page.
324
325In order to enable viewing your keys:
326
3271. Set the value of `allowKeysExposure` to `true` in `config.yaml` file.
3282. Restart the SillyTavern server.
3293. Click the 'View hidden API keys' link at the bottom right of the API Connection Panel.
330
331## Command-line arguments317## Command-line arguments
332318
333You can pass command-line arguments to SillyTavern server startup to override some settings in `config.yaml`.319You can pass command-line arguments to SillyTavern server startup to override some settings in `config.yaml`.
@@ -380,32 +366,7 @@ Most often this is for people who want to use SillyTavern on their mobile phones
380366
381Read the detailed guide on how to set up remote connections in the [Docs](https://docs.sillytavern.app/usage/remoteconnections/).367Read the detailed guide on how to set up remote connections in the [Docs](https://docs.sillytavern.app/usage/remoteconnections/).
382368
383You may also want to configure SillyTavern user profiles with (optional) password protection: [Users](https://docs.sillytavern.app/installation/st-1.12.0-migration-guide/#users).369You may also want to configure SillyTavern user profiles with (optional) password protection: [Users](https://docs.sillytavern.app/administration/multi-user/).
384
385## Performance issues?
386
387### General tips
388
3891. Disable the Blur Effect and enable Reduced Motion on the User Settings panel (UI Theme toggles category).
3902. If using response streaming, set the streaming FPS to a lower value (10-15 FPS is recommended).
3913. Make sure the browser is enabled to use GPU acceleration for rendering.
392
393### Input lag
394
395Performance degradation, particularly input lag, is most commonly attributed to browser extensions. Known problematic extensions include:
396
397* iCloud Password Manager
398* DeepL Translation
399* AI-based grammar correction tools
400* Various ad-blocking extensions
401
402If you experience performance issues and cannot identify the cause, or suspect an issue with SillyTavern itself, please:
403
4041. [Record a performance profile](https://developer.chrome.com/docs/devtools/performance/reference)
4052. Export the profile as a JSON file
4063. Submit it to the development team for analysis
407
408We recommend first testing with all browser extensions and third-party SillyTavern extensions disabled to isolate the source of the performance degradation.
409370
410## License and credits371## License and credits
411372