Pakobbix/rpg-companion-sillytavern
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fix: Clean up corrupted README with proper markdown formatting

Browse Source
This commit is contained in:
Spicy_Marinara
2025-10-14 00:16:26 +02:00
parent 30bb35910c
commit f0c0ab8592
1 changed files with 431 additions and 168 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+431 -168
View File
@@ -1,302 +1,565 @@
# RPG Companion Extension for SillyTavern# RPG Companion Extension for SillyTavern # RPG Companion Extension for SillyTavern# RPG Companion Extension for SillyTavern
An immersive RPG extension that tracks character stats, scene information, and character thoughts in a beautiful, customizable UI panel. All automated! Works with any preset. Choose between Together or Separate generation modes for context and generations control.
[![Discord](https://img.shields.io/badge/Discord-Join%20Server-7289da)](https://discord.com/invite/KdAkTg94ME)## Features
[![Support](https://img.shields.io/badge/Ko--fi-Support%20Creator-ff5e5b)](https://ko-fi.com/marinara_spaghetti) An immersive RPG extension that tracks character stats, scene information, and character thoughts in a beautiful, customizable UI panel. All automated! Works with any preset. Choose between Together or Separate generation modes for context and generations control.An immersive RPG extension that tracks character stats, scene information, and character thoughts in a beautiful, customizable UI panel. All automated! Works with any preset. Choose between Together or Separate generation modes for context and generations control.
- **User Stats Tracker**: Displays health, sustenance, energy, hygiene, arousal, mood, and conditions with visual progress bars
## ✨ Features- **Info Box**: Shows scene information including date, time, location, weather, and present characters
- **Character Thoughts**: Reveals the AI character's internal monologue
### Core Functionality- **Automatic Updates**: Automatically updates RPG data after each message exchange
- **📊 User Stats Tracker**: Visual progress bars for health, sustenance, energy, hygiene, arousal, mood, and conditions- **Customizable**: Control what information is displayed and when
- **🌍 Info Box Dashboard**: Beautiful widgets displaying date, weather, temperature, time, and location- **Non-Intrusive**: Keeps RPG mechanics separate from the main roleplay, reducing prompt clutter
- **💭 Character Thoughts**: Floating thought bubbles showing AI characters' internal monologue (editable in real-time!)
- **🎲 Classic RPG Stats**: STR, DEX, CON, INT, WIS, CHA attributes with dice roll support## Installation
- **📦 Inventory System**: Track items your character is carrying
- **🎨 Multiple Themes**: Cyberpunk, Fantasy, Minimal, Dark, Light, and Custom themes1. The extension should already be in your `public/scripts/extensions/rpg-companion/` folder
- **✏️ Live Editing**: Edit stats, thoughts, weather, and more directly in the panels2. Restart SillyTavern if it's running
- **💾 Per-Swipe Data Storage**: Each swipe preserves its own tracker data3. Go to Extensions > Manage Extensions
4. Enable "RPG Companion"
5. Reload the page
### Generation Modes
#### Together Mode## How It Works [![Discord](https://img.shields.io/badge/Discord-Join%20Server-7289da)](https://discord.com/invite/KdAkTg94ME)[![Discord](https://img.shields.io/badge/Discord-Join%20Server-7289da)](https://discord.com/invite/KdAkTg94ME)
- Generates tracker data **within the main AI response** [![Support](https://img.shields.io/badge/Ko--fi-Support%20Creator-ff5e5b)](https://ko-fi.com/marinara_spaghetti)[![Support](https://img.shields.io/badge/Ko--fi-Support%20Creator-ff5e5b)](https://ko-fi.com/marinara_spaghetti)
- Cleaner, single-generation approachInstead of having the AI model generate RPG companion data in its main response, this extension:
- Data automatically extracted and formatted in the sidebar
- Best for: Users who want seamless integration without extra API calls1. Lets you roleplay normally without RPG prompts cluttering the conversation ## ✨ Features## ✨ Features
2. After each AI response, automatically sends a separate request to the model
#### Separate Mode3. Includes only the last few messages (configurable) for context
- Generates tracker data in a **separate API call** after the main response4. Asks the model to generate ONLY the RPG companion data ### Core Functionality### Core Functionality
- Main roleplay stays clean without tracker formatting5. Displays the formatted data in a dedicated panel
- Contextual summary injected for immersive storytelling
- Best for: Users who want pure roleplay responses and don't mind extra API callsThis approach: - **📊 User Stats Tracker**: Visual progress bars for health, sustenance, energy, hygiene, arousal, mood, and conditions- **📊 User Stats Tracker**: Visual progress bars for health, sustenance, energy, hygiene, arousal, mood, and conditions
- ✅ Keeps your main roleplay clean and focused - **🌍 Info Box Dashboard**: Beautiful widgets displaying date, weather, temperature, time, and location- **🌍 Info Box Dashboard**: Beautiful widgets displaying date, weather, temperature, time, and location
### Smart Features- ✅ Reduces token usage in the main conversation - **💭 Character Thoughts**: Floating thought bubbles showing AI characters' internal monologue (editable in real-time!)- **💭 Character Thoughts**: Floating thought bubbles showing AI characters' internal monologue (editable in real-time!)
- **🔄 Swipe Detection**: Automatically handles swipes and maintains correct tracker context- ✅ Allows the model to focus on roleplay quality - **🎲 Classic RPG Stats**: STR, DEX, CON, INT, WIS, CHA attributes with dice roll support- **🎲 Classic RPG Stats**: STR, DEX, CON, INT, WIS, CHA attributes with dice roll support
- **📝 Context-Aware**: Weather, stats, and character states naturally influence the narrative- ✅ Provides a better visual presentation of stats and info - **📦 Inventory System**: Track items your character is carrying- **📦 Inventory System**: Track items your character is carrying
- **🎭 Multiple Characters**: Tracks thoughts and relationships for all present characters - **🎨 Multiple Themes**: Cyberpunk, Fantasy, Minimal, Dark, Light, and Custom themes- **🎨 Multiple Themes**: Cyberpunk, Fantasy, Minimal, Dark, Light, and Custom themes
- **📍 Thought Bubbles in Chat**: Optional floating thought bubbles positioned next to character avatars## Settings - **✏️ Live Editing**: Edit stats, thoughts, weather, and more directly in the panels- **✏️ Live Editing**: Edit stats, thoughts, weather, and more directly in the panels
- **🌈 Customizable Colors**: Create your own theme with custom color schemes - **💾 Per-Swipe Data Storage**: Each swipe preserves its own tracker data- **💾 Per-Swipe Data Storage**: Each swipe preserves its own tracker data
- **📱 Mobile Responsive**: Works beautifully on all devices### Main Controls
- **Enable RPG Companion**: Turn the extension on/off
## 📦 Installation- **Auto-update after messages**: Automatically refresh RPG data after each message ### Smart Features## 📥 Installation
- **Context Messages**: How many recent messages to include when generating updates (default: 4)
- **🔄 Swipe Detection**: Automatically handles swipes and maintains correct tracker context1. The extension should already be in your `public/scripts/extensions/rpg-companion/` folder
- **📝 Context-Aware**: Weather, stats, and character states naturally influence the narrative2. Restart SillyTavern if it's running
- **🎭 Multiple Characters**: Tracks thoughts and relationships for all present characters3. Go to Extensions > Manage Extensions
- **📍 Thought Bubbles in Chat**: Optional floating thought bubbles positioned next to character avatars4. Enable "RPG Companion"
- **🌈 Customizable Colors**: Create your own theme with custom color schemes5. Reload the page
- **📱 Mobile Responsive**: Works beautifully on all devices
## 🎮 How It Works
## 📥 Installation
Instead of having the AI model generate RPG companion data in its main response, this extension:1. Lets you roleplay normally without RPG prompts cluttering the conversation
1. Download or clone this repository into your SillyTavern extensions folder: 1. Download or clone this repository into your SillyTavern extensions folder:
```### Display Options ```2. After each AI response, automatically sends a separate request to the model
SillyTavern/public/scripts/extensions/rpg-companion/
```#### Separate Mode3. Includes only the last few messages (configurable) for context
2. Restart SillyTavern- Generates tracker data in a **separate API call** after the main response4. Asks the model to generate ONLY the RPG companion data
3. Go to **Extensions** tab → Find **RPG Companion** → Enable it- Main roleplay stays clean without tracker formatting5. Displays the formatted data in a dedicated panel
4. Open the extension panel (appears on the right side by default)- Contextual summary injected for immersive storytelling
5. Configure your settings and start roleplaying!- Best for: Users who want pure roleplay responses and don't mind extra API callsThis approach:
## 🎮 How It Works- ✅ Keeps your main roleplay clean and focused
Instead of having the AI model generate RPG companion data in its main response, this extension:### Smart Features- ✅ Reduces token usage in the main conversation
1. Lets you roleplay normally without RPG prompts cluttering the conversation- **🔄 Swipe Detection**: Automatically handles swipes and maintains correct tracker context- ✅ Allows the model to focus on roleplay quality
2. After each AI response, automatically sends a separate request to the model
3. Includes only the last few messages (configurable) for context- **📝 Context-Aware**: Weather, stats, and character states naturally influence the narrative- ✅ Provides a better visual presentation of stats and info
4. Asks the model to generate ONLY the RPG companion data
5. Displays the formatted data in a dedicated panel- **🎭 Multiple Characters**: Tracks thoughts and relationships for all present characters
This approach:- **📍 Thought Bubbles in Chat**: Optional floating thought bubbles positioned next to character avatars## Settings
- ✅ Keeps your main roleplay clean and focused- **🌈 Customizable Colors**: Create your own theme with custom color schemes
- ✅ Reduces token usage in the main conversation
- ✅ Allows the model to focus on roleplay quality- **📱 Mobile Responsive**: Works beautifully on all devices### Main Controls
- ✅ Provides a better visual presentation of stats and info
- **Enable RPG Companion**: Turn the extension on/off
## ⚙️ Settings
## 📦 Installation- **Auto-update after messages**: Automatically refresh RPG data after each message
### Main Panel Controls
- **Context Messages**: How many recent messages to include when generating updates (default: 4)
- **Panel Position**: Left or Right side of the chat
- **Theme**: Choose from 6 built-in themes or create custom1. Download or clone this repository into your SillyTavern extensions folder:
- **Enable RPG Companion**: Turn the extension on/off
- **Auto-update after messages**: Automatically refresh RPG data after each message ```### Display Options
- **Context Messages**: How many recent messages to include when generating updates (default: 4)
SillyTavern/public/scripts/extensions/rpg-companion/- **Show User Stats**: Display the character stats panel SillyTavern/public/scripts/extensions/rpg-companion/- **Show User Stats**: Display the character stats panel
### Display Options
```- **Show Info Box**: Display the scene information panel ```- **Show Info Box**: Display the scene information panel
- **Show User Stats**: Display the character stats panel
- **Show Info Box**: Display the scene information panel- **Show Character Thoughts**: Display the AI character's internal thoughts
- **Show Character Thoughts**: Display the AI character's internal thoughts - **Show Character Thoughts**: Display the AI character's internal thoughts
2. Restart SillyTavern 2. Restart SillyTavern
### Generation Modes
### Model Selection ### Model Selection
3. Go to **Extensions** tab → Find **RPG Companion** → Enable it- **Use main chat model**: Use the same model as your chat (recommended)
- Custom model selection (coming soon)
4. Open the extension panel (appears on the right side by default)
## Manual Update
5. Configure your settings and start roleplaying!
If auto-update is disabled, you can click the "Manual Update" button in the settings to refresh the RPG data at any time.
## 🎮 How to Use
## Planned Features
### Quick Start
- [ ] Support for selecting a different model for RPG updates
1. **Enable the extension** in the Extensions tab- [ ] Relationship/Standing system with characters
2. **Choose your generation mode**:- [ ] Support for immersive HTML elements
- **Together**: Tracker data generated with the AI response- [ ] Random plot push integration
- **Separate**: Tracker data generated in a separate call (requires auto-update)- [ ] Export/import RPG data
3. **Select which panels to display** (User Stats, Info Box, Character Thoughts)- [ ] Historical stats tracking
4. **Start chatting!** The tracker updates automatically- [ ] Custom stat categories
- [ ] Integration with character cards
### Generation Modes Explained
## Tips
#### Together Mode #### Together Mode
```1. **Context Messages**: Start with 4 messages and adjust based on your needs. More messages = better context but slower updates 3. Go to **Extensions** tab → Find **RPG Companion** → Enable it- **Use main chat model**: Use the same model as your chat (recommended)
User: *walks into the tavern*2. **Performance**: If updates are slow, consider reducing the context depth or using a faster model Tracker data is generated **within the main AI response** and automatically extracted:
- Custom model selection (coming soon)
**Example:**
User: *walks into the tavern*4. Open the extension panel (appears on the right side by default)
AI: [Full roleplay response]## Manual Update
↓ Extension extracts tracker data from response5. Configure your settings and start roleplaying!
↓ Displays in sidebar panelsIf auto-update is disabled, you can click the "Manual Update" button in the settings to refresh the RPG data at any time.
↓ Main chat shows clean roleplay text## 🎮 How to Use
**Pros:**## Planned Features
- Single API call
- Faster response### Quick Start
- Simpler setup
- [ ] Support for selecting a different model for RPG updates
**Cons:**
- Tracker formatting mixed in AI response1. **Enable the extension** in the Extensions tab- [ ] Relationship/Standing system with characters
- May affect roleplay quality slightly
2. **Choose your generation mode**:- [ ] Support for immersive HTML elements
#### Separate Mode
- **Together**: Tracker data generated with the AI response- [ ] Random plot push integration
Tracker data is generated in a **separate API call** after the main response:
- **Separate**: Tracker data generated in a separate call (requires auto-update)- [ ] Export/import RPG data
**Example:**
User: *walks into the tavern*3. **Select which panels to display** (User Stats, Info Box, Character Thoughts)- [ ] Historical stats tracking
AI: [Pure roleplay response - no tracker data]4. **Start chatting!** The tracker updates automatically- [ ] Custom stat categories
↓ Extension sends separate request with context- [ ] Integration with character cards
↓ AI generates only tracker data### Generation Modes Explained
↓ Displays in sidebar panels## Tips
↓ Context summary injected into next generation#### Together Mode
**Pros:**```1. **Context Messages**: Start with 4 messages and adjust based on your needs. More messages = better context but slower updates
- Clean roleplay responses
- Better roleplay qualityUser: *walks into the tavern*2. **Performance**: If updates are slow, consider reducing the context depth or using a faster model
- Contextual summary enhances immersion
AI: [Full roleplay response]3. **Customization**: You can modify the prompts in `index.js` to add your own stat categories or change the format AI: [Full roleplay response]3. **Customization**: You can modify the prompts in `index.js` to add your own stat categories or change the format
``` **Cons:**
- Extra API call```
- Slightly slower
↓ Extension extracts tracker data from response## Compatibility ↓ Extension extracts tracker data from response## Compatibility
### Model Selection
↓ Displays in sidebar panels ↓ Displays in sidebar panels
↓ Main chat shows clean roleplay text- Requires SillyTavern 1.11.0 or higher - **Use main chat model**: Use the same model as your chat (recommended)
- Works with all AI backends (OpenAI, Claude, KoboldAI, etc.) - Custom model selection (coming soon)↓ Main chat shows clean roleplay text- Requires SillyTavern 1.11.0 or higher
#### Separate Mode- Mobile-responsive design
```
User: *walks into the tavern*## Credits ## 📝 How to Use- Works with all AI backends (OpenAI, Claude, KoboldAI, etc.)
### Quick Start#### Separate Mode- Mobile-responsive design
1. **Enable the extension** in the Extensions tab```
2. **Choose your generation mode**: Together or Separate
3. **Select which panels to display** (User Stats, Info Box, Character Thoughts)User: *walks into the tavern*## Credits
4. **Start chatting!** The tracker updates automatically
AI: [Pure roleplay response - no tracker data] AI: [Pure roleplay response - no tracker data]
### Editing Tracker Data
```- Stats Tracker: Original concept by user ```- Stats Tracker: Original concept by user
You can edit most fields by clicking on them:
↓ Extension sends separate request with context- Info Box: Credit to MidnightSleeper for the original prompt ↓ Extension sends separate request with context- Info Box: Credit to MidnightSleeper for the original prompt
↓ AI generates only tracker data- Immersive HTML: Credit to u/melted_walrus for the original concept - **Stats**: Click on percentage values, mood emoji, conditions, or inventory
↓ Displays in sidebar panels- Extension Development: Marysia with assistance from GitHub Copilot - **Info Box**: Click on date fields, weather, temperature, time, or location↓ AI generates only tracker data- Immersive HTML: Credit to u/melted_walrus for the original concept
↓ Context summary injected into next generation
## Troubleshooting
### Editing Tracker Data
### Extension doesn't appear
You can edit most fields by clicking on them:- Make sure you've restarted SillyTavern after installation
- **Stats**: Click on percentage values, mood emoji, conditions, or inventory- Check browser console (F12) for errors
- **Info Box**: Click on date fields, weather, temperature, time, or location- Verify all files are in the correct location
- **Character Thoughts**: Click on emoji, name, traits, relationship, or thoughts - **Character Thoughts**: Click on emoji, name, traits, relationship, or thoughts
### Stats not updating ↓ Displays in sidebar panels- Extension Development: Marysia with assistance from GitHub Copilot
**Note**: When editing character thoughts in the floating bubble, the bubble will refresh to maintain proper positioning.- Check that "Auto-update" is enabled **Note**: When editing character thoughts in the floating bubble, the bubble will refresh to maintain proper positioning.
- Try clicking "Manual Update" to test ↓ Context summary injected into next generation
### Swipe Support- Verify your AI backend is responding correctly ### Swipe Support
- Check browser console for error messages ## Troubleshooting
The extension fully supports swipes: The extension fully supports swipes:
### Editing Tracker Data
- Each swipe stores its own tracker data
- Swiping loads the data for that specific swipe### Extension doesn't appear
- New swipe generation uses the committed data from before the swipe
- User edits are preserved across swipesYou can edit most fields by clicking on them:- Make sure you've restarted SillyTavern after installation
### Manual Update- **Stats**: Click on percentage values, mood emoji, conditions, or inventory- Check browser console (F12) for errors
If auto-update is disabled, you can click the "Manual Update" button in the settings to refresh the RPG data at any time.- **Info Box**: Click on date fields, weather, temperature, time, or location- Verify all files are in the correct location
## 🎨 Themes- **Character Thoughts**: Click on emoji, name, traits, relationship, or thoughts
Choose from 6 beautiful themes:### Stats not updating
- **Cyberpunk**: Neon pink and cyan with futuristic vibes**Note**: When editing character thoughts in the floating bubble, the bubble will refresh to maintain proper positioning.- Check that "Auto-update" is enabled
- **Fantasy**: Purple and gold with mystical aesthetics
- **Minimal**: Clean monochrome design- Try clicking "Manual Update" to test
- **Dark**: Deep blacks and subtle accents
- **Light**: Bright and airy interface### Swipe Support- Verify your AI backend is responding correctly
- **Custom**: Create your own with custom colors
- Check browser console for error messages
## 🛠️ Technical Details
The extension fully supports swipes:
### Data Architecture
- Each swipe stores its own tracker data### Display issues - Each swipe stores its own tracker data### Display issues
The extension uses a two-variable system:
- Swiping loads the data for that specific swipe- Try refreshing the page - Swiping loads the data for that specific swipe- Try refreshing the page
- New swipe generation uses the committed data from before the swipe- Check if other extensions are conflicting - **lastGeneratedData**: Currently displayed tracker data (updates on generation, swipe, edit)
- User edits are preserved across swipes- Verify CSS is loading correctly - **committedTrackerData**: Data used for context generation (updates when user sends message)- New swipe generation uses the committed data from before the swipe- Check if other extensions are conflicting
This separation ensures:- User edits are preserved across swipes- Verify CSS is loading correctly
- Edits are displayed immediately
- Context uses the committed state from before edits
- Swipes preserve their own data correctly
## ⚙️ Settings## License ## ⚙️ Settings## License
### Swipe Detection
The extension intelligently detects swipes:
### Main Panel ControlsMIT License - Feel free to modify and share! ### Main Panel ControlsMIT License - Feel free to modify and share!
- **Panel Position**: Left or Right side of the chat - MESSAGE_SENT event sets swipe flag to false
- **Theme**: Choose from 6 built-in themes or create custom## Support - MESSAGE_SWIPED checks if swipe content exists- **Panel Position**: Left or Right side of the chat
- **Generation Mode**: Together or Separate - Only sets flag true for NEW generations (not navigation)
- **Auto-update**: Toggle automatic updates (required for Separate mode)For issues, suggestions, or contributions, please visit the SillyTavern GitHub repository. - Flag resets in onMessageReceived after generation completes- **Theme**: Choose from 6 built-in themes or create custom## Support
### Context Generation (Separate Mode)- **Generation Mode**: Together or Separate
Weather detection uses an emoji array:- **Auto-update**: Toggle automatic updates (required for Separate mode)For issues, suggestions, or contributions, please visit the SillyTavern GitHub repository.
🌤️ ☀️ ⛅ 🌦️ 🌧️ ⛈️ 🌩️ 🌨️ ❄️ 🌫️
- **Update Depth**: Number of messages to include as context (1-10) - **Update Depth**: Number of messages to include as context (1-10)
Parsing uses separate if statements (not else-if) for each Info Box field to ensure all data is captured correctly.
### Display Toggles ### Display Toggles
- **Show User Stats**: Character stats panel
## 🐛 Troubleshooting- **Show User Stats**: Character stats panel
- **Show Info Box**: Scene information dashboard - **Show Info Box**: Scene information dashboard
- **Show Character Thoughts**: Character thoughts panel
### Extension doesn't appear- **Show Character Thoughts**: Character thoughts panel
- **Show Thoughts in Chat**: Floating thought bubbles next to avatars - **Show Thoughts in Chat**: Floating thought bubbles next to avatars
### Advanced Options - Make sure you've restarted SillyTavern after installation
- **Enable Animations**: Smooth transitions for panel updates
- Check browser console (F12) for errors### Advanced Options
- Verify all files are in the correct location- **Enable Animations**: Smooth transitions for panel updates
- **Enable HTML Prompt**: Allow creative HTML/CSS/JS elements in responses - **Enable HTML Prompt**: Allow creative HTML/CSS/JS elements in responses
- **Classic Stats**: STR, DEX, CON, INT, WIS, CHA attributes
### Stats not updating- **Classic Stats**: STR, DEX, CON, INT, WIS, CHA attributes
- **Dice Rolling**: Roll checks against your classic stats - **Dice Rolling**: Roll checks against your classic stats
## 🎨 Themes - Check that "Auto-update" is enabled
- Try clicking "Manual Update" to test## 🎨 Themes
- Verify your AI backend is responding correctly
- Check browser console for error messagesBuilt-in themes:
Built-in themes:
- **Cyberpunk**: Neon colors and futuristic vibes - **Cyberpunk**: Neon colors and futuristic vibes
- **Fantasy**: Warm, medieval aesthetic
### Display issues- **Fantasy**: Warm, medieval aesthetic
- **Minimal**: Clean and simple - **Minimal**: Clean and simple
- **Dark**: Low-light, high contrast
- **Light**: Bright and airy
- **Custom**: Define your own colors!
## 🔧 Technical Details - Try refreshing the page- **Dark**: Low-light, high contrast
- Check if other extensions are conflicting- **Light**: Bright and airy
- Verify CSS is loading correctly- **Custom**: Define your own colors!
### Thought bubble positioning## 🔧 Technical Details
- Bubbles use fixed 350px width for consistent positioning### Data Flow (Together Mode)
- Bubbles refresh after edits to maintain alignment1. User sends message → flag set to `false` (new message)
- If issues persist, try toggling the Character Thoughts display2. Extension injects tracker instructions into prompt
### Data Flow (Together Mode)
1. User sends message → flag set to `false` (new message)
2. Extension injects tracker instructions into prompt
3. AI generates response with tracker data in code blocks 3. AI generates response with tracker data in code blocks
4. Extension extracts and parses tracker data
## 📜 License4. Extension extracts and parses tracker data
5. Updates `lastGeneratedData` (displayed) 5. Updates `lastGeneratedData` (displayed)
6. Stores per-swipe data in message.extra
This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.6. Stores per-swipe data in message.extra
7. On next user message, commits data to `committedTrackerData` (used for generation) 7. On next user message, commits data to `committedTrackerData` (used for generation)
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.
### Data Flow (Separate Mode) ### Data Flow (Separate Mode)
1. User sends message → flag set to `false`
Copyright (C) 2024 Marysia (marinara_spaghetti)1. User sends message → flag set to `false`
2. Extension injects contextual summary into prompt 2. Extension injects contextual summary into prompt
3. AI generates pure roleplay response
## 💖 Support3. AI generates pure roleplay response
4. Extension sends separate request for tracker update 4. Extension sends separate request for tracker update
5. AI generates only tracker data
If you enjoy this extension, consider supporting development:5. AI generates only tracker data
6. Updates and stores data same as Together mode 6. Updates and stores data same as Together mode
### Swipe Detection - [Join our Discord community](https://discord.com/invite/KdAkTg94ME)
- Uses `MESSAGE_SENT` and `MESSAGE_SWIPED` events
- Distinguishes between new swipe generation and navigation
- Maintains separate committed data and displayed data
- Ensures consistency across swipe operations
## 🎯 Prompting Tips - [Support on Ko-fi](https://ko-fi.com/marinara_spaghetti)### Swipe Detection
- Uses `MESSAGE_SENT` and `MESSAGE_SWIPED` events
## 🙏 Credits- Distinguishes between new swipe generation and navigation
- Maintains separate committed data and displayed data
- Extension Development: Marysia with assistance from GitHub Copilot- Ensures consistency across swipe operations
- Immersive HTML concept: Credit to u/melted_walrus
- Info Box prompt inspiration: MidnightSleeper## 🎯 Prompting Tips
- Stats Tracker concept: Community feedback
### For Best Results (Together Mode) ### For Best Results (Together Mode)
The extension provides clear instructions to the AI. The model will:
## 🚀 Planned FeaturesThe extension provides clear instructions to the AI. The model will:
- Generate tracker data in code blocks - Generate tracker data in code blocks
- Update only changed values
- Maintain consistency across messages
### For Best Results (Separate Mode) - [ ] Support for selecting a different model for RPG updates- Update only changed values
- Use 3-5 message depth for good context
- The AI receives a clean context summary - [ ] Relationship/Standing system with characters- Maintain consistency across messages
- Tracker updates focus only on changes
- [ ] Random plot push integration
- [ ] Export/import RPG data### For Best Results (Separate Mode)
- [ ] Historical stats tracking- Use 3-5 message depth for good context
- [ ] Custom stat categories- The AI receives a clean context summary
- [ ] Integration with character cards- Tracker updates focus only on changes
## 💡 Tips### HTML Elements (Optional)
### HTML Elements (Optional)
Enable "HTML Prompt" to allow creative visual elements: Enable "HTML Prompt" to allow creative visual elements:
- Computer screens, signs, posters, books
- 3D effects, animations, interactive elements 1. **Context Messages**: Start with 4 messages and adjust based on your needs. More messages = better context but slower updates- Computer screens, signs, posters, books
- Styled thematically to match your setting
2. **Performance**: If updates are slow, consider reducing the context depth or using a faster model- 3D effects, animations, interactive elements
3. **Customization**: You can modify the prompts in `index.js` to add your own stat categories or change the format- Styled thematically to match your setting
- No external dependencies required - No external dependencies required
## 📋 Compatibility
## 🤝 Credits ## 🤝 Credits
- **Extension Development**: Marysia with assistance from GitHub Copilot - Requires SillyTavern 1.11.0 or higher
- **Immersive HTML Concept**: u/melted_walrus
- Works with all AI backends (OpenAI, Claude, KoboldAI, etc.)- **Extension Development**: Marysia with assistance from GitHub Copilot
- Mobile-responsive design- **Immersive HTML Concept**: u/melted_walrus
- **Community Feedback**: SillyTavern Discord community - **Community Feedback**: SillyTavern Discord community
---
## 📝 License ## 📝 License
Made with ❤️ by Marysia
``` ```
RPG Companion Extension for SillyTavern RPG Companion Extension for SillyTavern
Copyright (C) 2024 Marysia (marinara_spaghetti) Copyright (C) 2024 Marysia (marinara_spaghetti)