From b8c99ef2c1b769442cf7ffc690a256f8303f87c7 Mon Sep 17 00:00:00 2001
From: RossAscends <124905043+RossAscends@users.noreply.github.com>
Date: Wed, 15 Mar 2023 05:15:40 +0900
Subject: [PATCH 1/2] Update readme.md
---
readme.md | 44 ++++++++++++++++++++++++++++++--------------
1 file changed, 30 insertions(+), 14 deletions(-)
diff --git a/readme.md b/readme.md
index 3831fe033..599c1e0a0 100644
--- a/readme.md
+++ b/readme.md
@@ -1,24 +1,40 @@
-### Silly TavernAI 1.2.8 mod
-#### Update to 1.3.0 is likely not happenning, but I _may_ backport some features in future
+### RossAscends 1.2.8 mods ported into Silly TavernAI 1.2.8
+####
+This branch includes:
+* base TavernAI 1.2.8
+* SillyLossy's extensive 1.2.8 modifications and functions (World Info, OobaBooga integration, soft prompts, character emotional expressions, etc.
+* UI/CSS/Quality of Life tweaks by RossAscends
#### Features:
-1. World Info support
-1. Character search bar
-1. New UI style (thanks @RossAscends)
-1. oobabooga's Text Generation WebUI support (thanks @im-not-tom).
**Make sure that --no-stream option is added and WebUI is running in notebook mode (not in --cai-chat or --chat)**
-1. Group Chats support
-1. Extensibility with various plugins (character expressions, memory simulation, etc.)
More details here: https://github.com/SillyLossy/TavernAI-extras
-1. Soft Prompt selector for KoboldAI
-1. User Avatar uploading
-1. ???
-1. PROFIT
+* HotKeys
+** Ctrl+Up = Connect to API
+** Ctrl+Left = view localled stored variables (in the browser console window)
+** Ctrl+Right = clear locally stored variables.
+** Ctrl+enter = Regenerate last AI response.
+
+* No more page refresh on character deletion
+* No more page refresh on user name change
+
+* Toggle option to automatically connect to API on page load
+* Toggle option to automatically load the most recently viewed character on page load
+* Better Token Counter - works on unsaved characters, and shows both permanent and temporary tokens.
+
+* Better Past Chats View
+** Chat files names are saved in a readable format of "(character) - (when it was created)"
+** Chat preview increased from 40 character to 300.
+
+* Now, by default the settings panel will close when you click away from it.
+* Clicking the Lock on the nav panel will hold the panel open, and this setting be remembered across sessions.
+* Nav panel status of open or closed will also be saved across sessions.
+
#### Questions or suggestions?
-Contact me on Discord: Cohee#1207
+Contact me on Discord: RossAscends#1779
#### License
* TAI Base: Unknown
-* My additions: Public domain (do whatever you want)
+* SillyLossy's TAI mod: Public domain
+* My additions: Public domain
From 2434822a448d6aeec6dc1be94a9171c07696acde Mon Sep 17 00:00:00 2001
From: RossAscends <124905043+RossAscends@users.noreply.github.com>
Date: Wed, 15 Mar 2023 05:52:25 +0900
Subject: [PATCH 2/2] Update readme.md
---
readme.md | 75 ++++++++++++++++++++++++++++++++++++++++++-------------
1 file changed, 58 insertions(+), 17 deletions(-)
diff --git a/readme.md b/readme.md
index 599c1e0a0..920717f03 100644
--- a/readme.md
+++ b/readme.md
@@ -1,40 +1,81 @@
-### RossAscends 1.2.8 mods ported into Silly TavernAI 1.2.8
-####
+## RossAscends 1.2.8 mods ported into Silly TavernAI 1.2.8
+
-This branch includes:
-* base TavernAI 1.2.8
-* SillyLossy's extensive 1.2.8 modifications and functions (World Info, OobaBooga integration, soft prompts, character emotional expressions, etc.
-* UI/CSS/Quality of Life tweaks by RossAscends
+## This branch includes:
+* Base TavernAI 1.2.8
+* SillyLossy's extensive 1.2.8 modifications and functions (
+ * World Info
+ * OobaBooga's TextGen WebUI API connection
+ * Soft prompts
+ * Character emotional expressions
+ * Auto-Summary of the chat history
-#### Features:
+...and...
+
+## UI/CSS/Quality of Life tweaks by RossAscends
+
+*Many of these were incorporated in SillyLossy's TAI branch already, but I updated them and split the Javascript into a separate file for this release.*
+
+* Mobile-friendly page design
* HotKeys
-** Ctrl+Up = Connect to API
-** Ctrl+Left = view localled stored variables (in the browser console window)
-** Ctrl+Right = clear locally stored variables.
-** Ctrl+enter = Regenerate last AI response.
+ * Ctrl+Up = Connect to API
+ * Ctrl+Left = view localled stored variables (in the browser console window)
+ * Ctrl+Right = clear locally stored variables.
+ * Ctrl+enter = Regenerate last AI response.
* No more page refresh on character deletion
* No more page refresh on user name change
-* Toggle option to automatically connect to API on page load
+* Toggle option to automatically connect to API on page load (currently only for Kobold)
* Toggle option to automatically load the most recently viewed character on page load
* Better Token Counter - works on unsaved characters, and shows both permanent and temporary tokens.
* Better Past Chats View
-** Chat files names are saved in a readable format of "(character) - (when it was created)"
-** Chat preview increased from 40 character to 300.
+ * New Chat filenames are saved in a readable format of "(character) - (when it was created)"
+ * Chat preview increased from 40 character to 300.
* Now, by default the settings panel will close when you click away from it.
* Clicking the Lock on the nav panel will hold the panel open, and this setting be remembered across sessions.
* Nav panel status of open or closed will also be saved across sessions.
+## Installation
-#### Questions or suggestions?
+*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)
+ 2. download the zip from this github
+ 3. unzip it into a folder of your choice
+ 4. run start.bat with aby double clicking or in a command line.
+ 5. Once the server has prepared everything for you, it will open a tab in your browser.
+
+## Remote connections
+
+Most often this is for people who want use TAI 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:
+
+```
+const whitelistMode = false;
+```
+to
+```
+const whitelistMode = true;
+```
+Save the file.
+Close, then restart your TAI server.
+
+You will now be able to connect from other devices.
+***Disclaimer: Anyone else who knows your IP address and TAI port number will be able to 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 consol, hit Enter > "IPv4" listing)
+if you want other people around the internet to connect, check [here](https://whatismyipaddress.com/) for 'IPv4'
+
+## Questions or suggestions?
Contact me on Discord: RossAscends#1779
-#### License
+## License
* TAI Base: Unknown
* SillyLossy's TAI mod: Public domain
-* My additions: Public domain
+* RossAscends' additions: Public domain