diff --git a/readme.md b/readme.md index 672d84825..f276c0fa4 100644 --- a/readme.md +++ b/readme.md @@ -1,11 +1,22 @@ -## Silly TavernAI mod. Based on fork of TavernAI 1.2.8 -### Brought to you by @SillyLossy and @RossAscends +# SillyTavern. Based on fork of TavernAI 1.2.8 +### Brought to you by @Cohee1207 and @RossAscends -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 -https://colab.research.google.com/github/SillyLossy/TavernAI-extras/blob/main/colab/GPU.ipynb +https://colab.research.google.com/github/Cohee1207/TavernAI-extras/blob/main/colab/GPU.ipynb + +## What is TavernAI? + +TavernAI is a user interface you can install on your computer (and Android phones) that allows you to interact text generation AIs and chat/roleplay with characters you or the community create. + +## 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. + +## 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 a rusty toaster. It's the AI system backend that needs to be powerful. ## Mobile support @@ -23,18 +34,18 @@ https://rentry.org/TAI_Termux * [Oobabooga's TextGen WebUI](https://github.com/oobabooga/text-generation-webui) API connection * Soft prompts selector for KoboldAI * Prompt generation formatting tweaking -* Extensibility support via [SillyLossy's TAI-extras](https://github.com/SillyLossy/TavernAI-extras) plugins +* Extensibility support via [SillyLossy's TAI-extras](https://github.com/Cohee1207/TavernAI-extras) plugins * 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 | +| Name | Description | Required Extra 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 | | +| Author's Note | 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 | | | D&D Dice | A set of 7 classic D&D dice for all your dice rolling needs.

*I used to roll the dice.
Feel the fear in my enemies' eyes* | None | image | ...and... @@ -67,7 +78,7 @@ https://rentry.org/TAI_Termux *NOTE: This branch is intended for local install purposes, and has not been tested on a colab or other cloud notebook service.* - 1. install [NodeJS](nodejs.org) + 1. install [NodeJS](https://nodejs.org/en) 2. download the zip from this github repo 3. unzip it into a folder of your choice 4. run start.bat via double clicking or in a command line. @@ -109,7 +120,7 @@ Contact us on Discord: Cohee#1207 or RossAscends#1779 ## License and credits * TAI Base by Humi: Unknown license -* SillyLossy's TAI mod: Public domain +* Cohee's TAI mod: Public domain * RossAscends' additions: Public domain * Portions of CncAnon's TavernAITurbo mod: Unknown license * Thanks oobabooga for compiling presets for TextGen diff --git a/server.js b/server.js index 70272a81b..f10202b79 100644 --- a/server.js +++ b/server.js @@ -174,9 +174,11 @@ app.use((req, res, next) => { if (req.url.startsWith('/characters/') && is_colab && process.env.googledrive == 2) { const filePath = path.join(charactersPath, decodeURIComponent(req.url.substr('/characters'.length))); + console.log('req.url: ' + req.url); + console.log(filePath); fs.access(filePath, fs.constants.R_OK, (err) => { if (!err) { - res.sendFile(filePath); + res.sendFile(filePath, { root: __dirname }); } else { res.send('Character not found: ' + filePath); //next();