From 7feceedb5c34bca91060e2c48336f5f7d48ac6ff Mon Sep 17 00:00:00 2001 From: Cohee Date: Wed, 5 Apr 2023 21:36:14 +0300 Subject: [PATCH] Rebranding --- README.md | 33 +++++++++------------------------ 1 file changed, 9 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index aca8eb1..c2f93c4 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,13 @@ # TavernAI - Extras ## What is this -A set of unofficial APIs for various TavernAI extensions. +A set of APIs for various SillyTavern extensions. -**You need to run the lastest version of my TavernAI mod. Grab it here: [Direct link to ZIP](https://github.com/SillyLossy/TavernAI/archive/refs/heads/main.zip), [Git repository](https://github.com/SillyLossy/TavernAI)** +**You need to run the lastest version of my TavernAI fork. Grab it here: [Direct link to ZIP](https://github.com/Cohee1207/SillyTavern/archive/refs/heads/main.zip), [Git repository](https://github.com/Cohee1207/SillyTavern)** All modules require at least 6 Gb of VRAM to run. With Stable Diffusion disabled, it will probably fit in 4 Gb. Alternatively, everything could also be run on the CPU. -Try on Colab (runs KoboldAI backend and TavernAI Extras server alongside): +Try on Colab (runs KoboldAI backend and TavernAI Extras server alongside): Open In Colab @@ -24,7 +24,7 @@ Try on Colab (runs KoboldAI backend and TavernAI Extras server alongside): - -## UI Extensions 🚀 - -### Will be moved to main project soon!! - -| Name | Description | Required [Modules](#modules) | Screenshot | -| ---------------- | ---------------------------------| ---------------------------- | ---------- | -| Image Captioning | Send a cute picture to your bot!

Picture select option will appear beside "Message send" button. | `caption` | | -| Character Expressions | See your character reacting to your messages!

**You need to provide your own character images!**

1. Create a folder in TavernAI called `public/characters/`, where `` is a name of your character.
2. For base emotion classification model, put six PNG files there with the following names: `joy.png`, `anger.png`, `fear.png`, `love.png`, `sadness.png`, `surprise.png`. Other models may provide another options.
3. Images only display in desktop mode. | `classify` | image | -| Memory | Chatbot long-term memory simulation using automatic message context summarization. | `summarize` | image | -| Floating Prompt | Adds a string to your scenario after certain amount of messages you send. Usage ideas: reinforce certain events during roleplay. Thanks @Ali឵#2222 for suggesting me that! | None | | - +* Start TavernAI with extensions support: set `enableExtensions` to `true` in [config.conf](https://github.com/Cohee1207/SillyTavern/blob/dev/config.conf) +* Navigate to TavernAI extensions menu and put in an API URL and tap "Connect" to load the extensions ## Modules