diff --git a/public/index.html b/public/index.html index df054e0da..579d328f9 100644 --- a/public/index.html +++ b/public/index.html @@ -176,7 +176,7 @@ - +
+ @@ -2032,7 +2032,7 @@

Personality summary

A brief description of the personality ?
- +
@@ -2042,7 +2042,7 @@ ? - +
@@ -2062,7 +2062,7 @@

Examples of dialogue

Forms a personality more clearly ?
- + diff --git a/readme.md b/readme.md index 5ac168377..c6c439013 100644 --- a/readme.md +++ b/readme.md @@ -1,18 +1,23 @@ # SillyTavern + ## Based on a fork of TavernAI 1.2.8 + ### Brought to you by Cohee, RossAscends and the SillyTavern community NOTE: We have added [a FAQ](faq.md) to answer most of your questions and help you get started. ### What is SillyTavern or TavernAI? + Tavern is a user interface you can install on your computer (and Android phones) that allows you to interact with text generation AIs and chat/roleplay with characters you or the community create. SillyTavern is a fork of TavernAI 1.2.8 which is under more active development and has added many major features. At this point, they can be thought of as completely independent programs. ### What do I need other than Tavern? + On its own Tavern is useless, as it's just a user interface. You have to have access to an AI system backend that can act as the roleplay character. There are various supported backends: OpenAPI API (GPT), KoboldAI (either running locally or on Google Colab), and more. You can read more about this in [the FAQ](faq.md). ### Do I need a powerful PC to run Tavern? + Since Tavern is only a user interface, it has tiny hardware requirements, it will run on anything. It's the AI system backend that needs to be powerful. ## Mobile support @@ -21,13 +26,13 @@ Since Tavern is only a user interface, it has tiny hardware requirements, it wil > **This fork can be run natively on Android phones using Termux. Please refer to this guide by ArroganceComplex#2659:** -https://rentry.org/STAI-Termux + **.webp character cards import/export is not supported in Termux. Use either JSON or PNG formats instead.** ## Questions or suggestions? -### We now have a community Discord server! +### We now have a community Discord server Get support, share favorite characters and prompts: @@ -36,11 +41,13 @@ Get support, share favorite characters and prompts: *** Get in touch with the developers directly: + * Discord: Cohee#1207 or RossAscends#1779 * Reddit: /u/RossAscends or /u/sillylossy * [Post a GitHub issue](https://github.com/Cohee1207/SillyTavern/issues) ## This version includes + * A heavily modified TavernAI 1.2.8 (more than 50% of code rewritten or optimized) * Swipes * Group chats: multi-bot rooms for characters to talk to you or each other @@ -54,12 +61,13 @@ Get in touch with the developers directly: * Prompt generation formatting tweaking * webp character card interoperability (PNG is still an internal format) * Extensibility support via [SillyLossy's TAI-extras](https://github.com/Cohee1207/TavernAI-extras) plugins - * Author's Note / Character Bias - * Character emotional expressions - * Auto-Summary of the chat history - * Sending images to chat, and the AI interpreting the content. + * Author's Note / Character Bias + * Character emotional expressions + * Auto-Summary of the chat history + * Sending images to chat, and the AI interpreting the content. ## UI Extensions 🚀 + | Name | Description | Required Extra Modules | Screenshot | | ---------------- | ---------------------------------| ---------------------------- | ---------- | | Image Captioning | Send a cute picture to your bot!

Picture select option will appear beside the "Message send" button. | `caption` | | @@ -78,7 +86,7 @@ Get in touch with the developers directly: * Left = swipe left * Right = swipe right (NOTE: swipe hotkeys are disabled when chatbar has something typed into it) * Ctrl+Left = view locally stored variables (in the browser console window) - * Enter (with chat bar selected) = send your message to AI + * Enter (with chat bar selected) = send your message to AI * Ctrl+Enter = Regenerate the last AI response * User Name Changes and Character Deletion no longer force the page to refresh. @@ -97,12 +105,12 @@ Get in touch with the developers directly: * Nav panel status of open or closed will also be saved across sessions. * Customizable chat UI: - * Play a sound when a new message arrives - * Switch between round or rectangle avatar styles - * Have a wider chat window on the desktop - * Optional semi-transparent glass-like panels - * Customizable page colors for 'main text', 'quoted text' 'italics text'. - * Customizable UI background color and blur amount + * Play a sound when a new message arrives + * Switch between round or rectangle avatar styles + * Have a wider chat window on the desktop + * Optional semi-transparent glass-like panels + * Customizable page colors for 'main text', 'quoted text' 'italics text'. + * Customizable UI background color and blur amount ## Installation @@ -115,6 +123,25 @@ Get in touch with the developers directly: > DO NOT RUN START.BAT WITH ADMIN PERMISSIONS ### Windows + +Installing via Git (reccomended for easy updating) + +Easy to follow guide with pretty pictures: + + + 1. Install [NodeJS](https://nodejs.org/en) (latest LTS version is recommended) + 3. Install [GitHub Desktop](https://central.github.com/deployments/desktop/desktop/latest/win32) + 4. Open Windows Explorer (Win+E) + 5. Browse to or Create a folder that is not controlled or monitored by Windows. (ex: C:\MySpecialFolder\) + 6. Open a Command Prompt inside that folder by clicking in the 'Address Bar' at the top, typing 'cmd', and pressing Enter. + 7. Once the black box (Command Prompt) pops up, type ONE of the following into it and press Enter: + - for Main Branch: git clone -b main + - for Dev Branch: git clone -b dev + 8. Once everything is cloned, double click Start.bat to make NodeJS install its requirements. + 9. The server will then start, and SillyTavern will popup in your browser. + +Installing via zip download + 1. install [NodeJS](https://nodejs.org/en) (latest LTS version is recommended) 2. download the zip from this GitHub repo 3. unzip it into a folder of your choice @@ -122,6 +149,7 @@ Get in touch with the developers directly: 5. Once the server has prepared everything for you, it will open a tab in your browser. ### Linux + 1. Run the `start.sh` script. 2. Enjoy. @@ -139,17 +167,20 @@ In order to enable viewing your keys by clicking a button in the API block: ## Remote connections Most often this is for people who want to use SillyTavern on their mobile phones while at home. -If you want to enable other devices to connect to your TAI server, open 'config.conf' in a text editor, and change: +If you want to enable other devices to connect to your TAI server, open 'config.conf' in a text editor, and change: ``` const whitelistMode = true; ``` -to + +to + ``` const whitelistMode = false; ``` -Save the file. -Restart your TAI server. + +Save the file. +Restart your TAI server. You will now be able to connect from other devices. @@ -166,13 +197,15 @@ The `whitelist` array in `config.conf` will be ignored if `whitelist.txt` exists ***Disclaimer: Anyone else who knows your IP address and TAI port number will be able to connect as well*** -To connect over wifi you'll need your PC's local wifi IP address - - (For Windows: windows button > type 'cmd.exe' in the search bar> type 'ipconfig' in the console, hit Enter > "IPv4" listing) +To connect over wifi you'll need your PC's local wifi IP address + +* (For Windows: windows button > type 'cmd.exe' in the search bar> type 'ipconfig' in the console, hit Enter > "IPv4" listing) if you want other people on the internet to connect, check [here](https://whatismyipaddress.com/) for 'IPv4' ### Still Unable To Connect? + - Create an inbound/outbound firewall rule for the port found in `config.conf`. Do NOT mistake this for portforwarding on your router, otherwise someone could find your chat logs and that's a big no-no. -- Enable the Private Network profile type in Settings > Network and Internet > Ethernet. This is VERY important for Windows 11, otherwise you would be unable to connect even with the aforementioned firewall rules. +* Enable the Private Network profile type in Settings > Network and Internet > Ethernet. This is VERY important for Windows 11, otherwise you would be unable to connect even with the aforementioned firewall rules. ## Performance issues? @@ -198,9 +231,10 @@ We're moving to 100% original content only policy, so old background images have You can find them archived here: -https://files.catbox.moe/1xevnc.zip + ## Screenshots + image image @@ -215,13 +249,13 @@ GNU Affero General Public License for more details.** * Cohee's modifications and derived code: AGPL v3 * RossAscends' additions: AGPL v3 * Portions of CncAnon's TavernAITurbo mod: Unknown license -* Waifu mode inspired by the work of PepperTaco (https://github.com/peppertaco/Tavern/) -* Thanks Pygmalion University for being awesome testers and suggesting cool features! +* Waifu mode inspired by the work of PepperTaco () +* Thanks Pygmalion University for being awesome testers and suggesting cool features! * Thanks oobabooga for compiling presets for TextGen -* poe-api client adapted from https://github.com/ading2210/poe-api (GPL v3) -* GraphQL files for poe: https://github.com/muharamdani/poe (ISC License) -* KoboldAI Presets from KAI Lite: https://lite.koboldai.net/ +* poe-api client adapted from (GPL v3) +* GraphQL files for poe: (ISC License) +* KoboldAI Presets from KAI Lite: * Noto Sans font by Google (OFL license) -* Icon theme by Font Awesome https://fontawesome.com (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) +* Icon theme by Font Awesome (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) * Linux startup script by AlpinDale * Thanks paniphons for providing a FAQ document