0.27.0 (#137)

* move memory agent to directory structure

* chromadb settings rework

* memory agent improvements
embedding presets
support switching embeddings without restart
support custom sentence transformer embeddings

* toggle to hide / show disabled clients

* add memory debug tools

* chromadb no longer needs its dedicated config entry

* add missing emits

* fix initial value

* hidden disabled clients no longer cause enumeration issues with client actions

* improve memory agent error handling and hot reloading

* more memory agent error handling

* DEBUG_MEMORY_REQUESTS off

* relock

* sim suite: fix issue with removing or changing characters

* relock

* fix issue where actor dialogue editor would break with multiple characters in the scene

* remove cruft

* implement interrupt function

* margin adjustments

* fix rubber banding issue in world editor when editing certain text fields

* status notification when re-importing vectorb due to embeddings change

* properly open new client context on agent actions

* move jiggle apply to the end of prompt tune stack

* narrator agent length limit and jiggle settings added - also improve post generation cleanup

* progress story prompt improvements

* narrator prompt and cleanup tweaks

* prompt tweak

* revert

* autocomplete dialogue improvements

* Unified process (#141)

* progress to unified process

* --dev arg

* use gunicorn to serve built frontend

* gunicorn config adjustments

* remove dist from gitignore

* revert

* uvicorn instead

* save decode

* graceful shutdown

* refactor unified process

* clean up frontend log messages

* more logging fixes

* 0.27.0

* startup message

* clean up scripts a bit

* fixes to update.bat

* fixes to install.bat

* sim suite supports generation cancellation

* debug

* simplify narrator prompts

* prompt tweaks

* unified docker file

* update docker compose config for unified docker file

* cruft

* fix startup in linux docker

* download punkt so its available

* prompt tweaks

* fix bug when editing scene outline would wipe message history

* add o1 models

* add sampler, scheduler and cfg config to a1111 visualizer

* update installation docs

* visualizer configurable timeout

* memory agent docs

* docs

* relock

* relock

* fix issue where changing embeddings on immutable scene would hang

* remove debug message

* take torch install out of poetry since conditionals don't work.

* torch gets installed through some dependency so put it back into poetry, but reinstall with cuda if cuda support exists

* fix install syntax

* no need for torchvision

* torch cuda install added to linux install script

* add torch cuda install to update.bat

* docs

* docs

* relock

* fix install.sh

* handle torch+cuda install in docker

* docs

* typo

.github/workflows/ci.yml

@@ -0,0 +1,30 @@
+name: ci 
+on:
+  push:
+    branches:
+      - master 
+      - main
+      - prep-0.26.0
+permissions:
+  contents: write
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Configure Git Credentials
+        run: |
+          git config user.name github-actions[bot]
+          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.x
+      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV 
+      - uses: actions/cache@v4
+        with:
+          key: mkdocs-material-${{ env.cache_id }}
+          path: .cache
+          restore-keys: |
+            mkdocs-material-
+      - run: pip install mkdocs-material mkdocs-awesome-pages-plugin mkdocs-glightbox
+      - run: mkdocs gh-deploy --force

.gitignore

@@ -9,6 +9,7 @@ talemate_env
 chroma
 config.yaml
 templates/llm-prompt/user/*.jinja2
+templates/world-state/*.yaml
 scenes/
 !scenes/infinity-quest-dynamic-scenario/
 !scenes/infinity-quest-dynamic-scenario/assets/

Dockerfile

@@ -0,0 +1,86 @@
+# Stage 1: Frontend build
+FROM node:21 AS frontend-build
+
+ENV NODE_ENV=development
+
+WORKDIR /app
+
+# Copy the frontend directory contents into the container at /app
+COPY ./talemate_frontend /app
+
+# Install all dependencies and build
+RUN npm install && npm run build
+
+# Stage 2: Backend build
+FROM python:3.11-slim AS backend-build
+
+WORKDIR /app
+
+# Install system dependencies
+RUN apt-get update && apt-get install -y \
+    bash \
+    gcc \
+    && rm -rf /var/lib/apt/lists/*
+
+# Install poetry
+RUN pip install poetry
+
+# Copy poetry files
+COPY pyproject.toml poetry.lock* /app/
+
+# Create a virtual environment
+RUN python -m venv /app/talemate_env
+
+# Activate virtual environment and install dependencies
+RUN . /app/talemate_env/bin/activate && \
+    poetry config virtualenvs.create false && \
+    poetry install --no-dev --no-root
+
+# Copy the Python source code
+COPY ./src /app/src
+
+# Conditional PyTorch+CUDA install
+ARG CUDA_AVAILABLE=false
+RUN . /app/talemate_env/bin/activate && \
+    if [ "$CUDA_AVAILABLE" = "true" ]; then \
+        echo "Installing PyTorch with CUDA support..." && \
+        pip uninstall torch torchaudio -y && \
+        pip install torch~=2.4.1 torchaudio~=2.4.1 --index-url https://download.pytorch.org/whl/cu121; \
+    fi
+
+# Stage 3: Final image
+FROM python:3.11-slim
+
+WORKDIR /app
+
+RUN apt-get update && apt-get install -y \
+    bash \
+    && rm -rf /var/lib/apt/lists/*
+
+# Copy virtual environment from backend-build stage
+COPY --from=backend-build /app/talemate_env /app/talemate_env
+
+# Copy Python source code
+COPY --from=backend-build /app/src /app/src
+
+# Copy Node.js build artifacts from frontend-build stage
+COPY --from=frontend-build /app/dist /app/talemate_frontend/dist
+
+# Copy the frontend WSGI file if it exists
+COPY frontend_wsgi.py /app/frontend_wsgi.py
+
+# Copy base config
+COPY config.example.yaml /app/config.yaml
+
+# Copy essentials
+COPY scenes templates chroma* /app/
+
+# Set PYTHONPATH to include the src directory
+ENV PYTHONPATH=/app/src:$PYTHONPATH
+
+# Make ports available to the world outside this container
+EXPOSE 5050
+EXPOSE 8080
+
+# Use bash as the shell, activate the virtual environment, and run backend server
+CMD ["poetry run src/talemate/server/run.py runserver --host 0.0.0.0 --port 5050 --frontend-host 0.0.0.0 --frontend-port 8080"]

Dockerfile.backend

@@ -1,25 +0,0 @@
-# Use an official Python runtime as a parent image
-FROM python:3.11-slim
-
-# Set the working directory in the container
-WORKDIR /app
-
-# Copy the current directory contents into the container at /app
-COPY ./src /app/src
-
-# Copy poetry files
-COPY pyproject.toml /app/
-# If there's a poetry lock file, include the following line
-COPY poetry.lock /app/
-
-# Install poetry
-RUN pip install poetry
-
-# Install dependencies
-RUN poetry install --no-dev
-
-# Make port 5050 available to the world outside this container
-EXPOSE 5050
-
-# Run backend server
-CMD ["poetry", "run", "python", "src/talemate/server/run.py", "runserver", "--host", "0.0.0.0", "--port", "5050"]

Dockerfile.frontend

@@ -1,23 +0,0 @@
-# Use an official node runtime as a parent image
-FROM node:20
-
-# Make sure we are in a development environment (this isn't a production ready Dockerfile)
-ENV NODE_ENV=development
-
-# Echo that this isn't a production ready Dockerfile
-RUN echo "This Dockerfile is not production ready. It is intended for development purposes only."
-
-# Set the working directory in the container
-WORKDIR /app
-
-# Copy the frontend directory contents into the container at /app
-COPY ./talemate_frontend /app
-
-# Install all dependencies
-RUN npm install
-
-# Make port 8080 available to the world outside this container
-EXPOSE 8080
-
-# Run frontend server
-CMD ["npm", "run", "serve"]

README.md

@@ -7,7 +7,24 @@ Roleplay with AI with a focus on strong narration and consistent world and game
 |![Screenshot 4](docs/img/0.17.0/ss-4.png)|![Screenshot 1](docs/img/0.19.0/Screenshot_15.png)|
 |![Screenshot 2](docs/img/0.19.0/Screenshot_16.png)|![Screenshot 3](docs/img/0.19.0/Screenshot_17.png)|
 
-Supported APIs:
+## Core Features
+
+- Multiple agents for dialogue, narration, summarization, direction, editing, world state management, character/scenario creation, text-to-speech, and visual generation
+- Supports per agent API selection
+- Long-term memory and passage of time tracking
+- Narrative world state management to reinforce character and world truths
+- Creative tools for managing NPCs, AI-assisted character, and scenario creation with template support
+- Context management for character details, world information, past events, and pinned information
+- Customizable templates for all prompts using Jinja2
+- Modern, responsive UI
+
+## Documentation
+
+- [Installation and Getting started](https://vegu-ai.github.io/talemate/)
+- [User Guide](https://vegu-ai.github.io/talemate/user-guide/interacting/)
+
+## Supported APIs
+
 - [OpenAI](https://platform.openai.com/overview)
 - [Anthropic](https://www.anthropic.com/)
 - [mistral.ai](https://mistral.ai/)
@@ -19,246 +36,9 @@ Supported self-hosted APIs:
 - [KoboldCpp](https://koboldai.org/cpp) ([Local](https://koboldai.org/cpp), [Runpod](https://koboldai.org/runpodcpp), [VastAI](https://koboldai.org/vastcpp), also includes image gen support)
 - [oobabooga/text-generation-webui](https://github.com/oobabooga/text-generation-webui) (local or with runpod support)
 - [LMStudio](https://lmstudio.ai/)
+- [TabbyAPI](https://github.com/theroyallab/tabbyAPI/)
 
 Generic OpenAI api implementations (tested and confirmed working):
 - [DeepInfra](https://deepinfra.com/)
 - [llamacpp](https://github.com/ggerganov/llama.cpp) with the `api_like_OAI.py` wrapper
 - let me know if you have tested any other implementations and they failed / worked or landed somewhere in between
-
-## Core Features
-
-- Multiple AI agents for dialogue, narration, summarization, direction, editing, world state management, character/scenario creation, text-to-speech, and visual generation
-- Support for multiple AI clients and APIs
-- Long-term memory using ChromaDB and passage of time tracking
-- Narrative world state management to reinforce character and world truths
-- Creative tools for managing NPCs, AI-assisted character, and scenario creation with template support
-- Context management for character details, world information, past events, and pinned information
-- Integration with Runpod
-- Customizable templates for all prompts using Jinja2
-- Modern, responsive UI
-
-# Instructions
-
-Please read the documents in the `docs` folder for more advanced configuration and usage.
-
-- [Quickstart](#quickstart)
-    - [Installation](#installation)
-        - [Windows](#windows)
-        - [Linux](#linux)
-        - [Docker](#docker)
-    - [Connecting to an LLM](#connecting-to-an-llm)
-        - [OpenAI / mistral.ai / Anthropic](#openai--mistralai--anthropic)
-        - [Text-generation-webui / LMStudio](#text-generation-webui--lmstudio)
-            - [Specifying the correct prompt template](#specifying-the-correct-prompt-template)
-            - [Recommended Models](#recommended-models)
-        - [DeepInfra via OpenAI Compatible client](#deepinfra-via-openai-compatible-client)
-        - [Google Gemini](#google-gemini)
-            - [Google Cloud Setup](#google-cloud-setup)
-    - [Ready to go](#ready-to-go)
-    - [Load the introductory scenario "Infinity Quest"](#load-the-introductory-scenario-infinity-quest)
-    - [Loading character cards](#loading-character-cards)
-- [Configure for hosting](#configure-for-hosting)
-- [Text-to-Speech (TTS)](docs/tts.md)
-- [Visual Generation](docs/visual.md)
-- [ChromaDB (long term memory) configuration](docs/chromadb.md)
-- [Runpod Integration](docs/runpod.md)
-- [Prompt template overrides](docs/templates.md)
-
-# Quickstart
-
-## Installation
-
-Post [here](https://github.com/vegu-ai/talemate/issues/17) if you run into problems during installation.
-
-There is also a [troubleshooting guide](docs/troubleshoot.md) that might help.
-
-### Windows
-
-1. Download and install Python 3.10 or Python 3.11 from the [official Python website](https://www.python.org/downloads/windows/). :warning: python3.12 is currently not supported.
-1. Download and install Node.js v20 from the [official Node.js website](https://nodejs.org/en/download/). This will also install npm. :warning: v21 is currently not supported.
-1. Download the Talemate project to your local machine. Download from [the Releases page](https://github.com/vegu-ai/talemate/releases).
-1. Unpack the download and run `install.bat` by double clicking it. This will set up the project on your local machine.
-1. Once the installation is complete, you can start the backend and frontend servers by running `start.bat`.
-1. Navigate your browser to http://localhost:8080
-
-### Linux
-
-`python 3.10` or `python 3.11` is required. :warning: `python 3.12` not supported yet. 
-
-`nodejs v19 or v20` :warning: `v21` not supported yet.
-
-1. `git clone https://github.com/vegu-ai/talemate.git`
-1. `cd talemate`
-1. `source install.sh`
-1. Start the backend: `python src/talemate/server/run.py runserver --host 0.0.0.0 --port 5050`.
-1. Open a new terminal, navigate to the `talemate_frontend` directory, and start the frontend server by running `npm run serve`.
-
-### Docker
-
-:warning: Some users currently experience issues with missing dependencies inside the docker container, issue tracked at [#114](https://github.com/vegu-ai/talemate/issues/114)
-
-1. `git clone https://github.com/vegu-ai/talemate.git`
-1. `cd talemate`
-1. `cp config.example.yaml config.yaml`
-1. `docker compose up`
-1. Navigate your browser to http://localhost:8080
-
-:warning: When connecting local APIs running on the hostmachine (e.g. text-generation-webui), you need to use `host.docker.internal` as the hostname.
-
-#### To shut down the Docker container
-
-Just closing the terminal window will not stop the Docker container. You need to run `docker compose down` to stop the container.
-
-#### How to install Docker
-
-1. Download and install Docker Desktop from the [official Docker website](https://www.docker.com/products/docker-desktop).
-
-# Connecting to an LLM
-
-On the right hand side click the "Add Client" button. If there is no button, you may need to toggle the client options by clicking this button:
-
-![Client options](docs/img/client-options-toggle.png)
-
-![No clients](docs/img/0.21.0/no-clients.png)
-
-## OpenAI / mistral.ai / Anthropic
-
-The setup is the same for all three, the example below is for OpenAI.
-
-If you want to add an OpenAI client, just change the client type and select the appropriate model.
-
-![Add client modal](docs/img/0.21.0/openai-setup.png)
-
-If you are setting this up for the first time, you should now see the client, but it will have a red dot next to it, stating that it requires an API key.
-
-![OpenAI API Key missing](docs/img/0.18.0/openai-api-key-1.png)
-
-Click the `SET API KEY` button. This will open a modal where you can enter your API key.
-
-![OpenAI API Key missing](docs/img/0.21.0/openai-add-api-key.png)
-
-Click `Save` and after a moment the client should have a green dot next to it, indicating that it is ready to go.
-
-![OpenAI API Key set](docs/img/0.18.0/openai-api-key-3.png)
-
-## Text-generation-webui / LMStudio
-
-> :warning: As of version 0.13.0 the legacy text-generator-webui API `--extension api` is no longer supported, please use their new `--extension openai` api implementation instead. 
-
-In the modal if you're planning to connect to text-generation-webui, you can likely leave everything as is and just click Save.
-
-![Add client modal](docs/img/0.21.0/text-gen-webui-setup.png)
-
-### Specifying the correct prompt template
-
-For good results it is **vital** that the correct prompt template is specified for whichever model you have loaded.
-
-Talemate does come with a set of pre-defined templates for some popular models, but going forward, due to the sheet number of models released every day, understanding and specifying the correct prompt template is something you should familiarize yourself with.
-
-If the text-gen-webui client shows a yellow triangle next to it, it means that the prompt template is not set, and it is currently using the default `VICUNA` style prompt template.
-
-![Default prompt template](docs/img/0.21.0/prompt-template-default.png)
-
-Click the two cogwheels to the right of the triangle to open the client settings.
-
-![Client settings](docs/img/0.21.0/select-prompt-template.png)
-
-You can first try by clicking the `DETERMINE VIA HUGGINGFACE` button, depending on the model's README file, it may be able to determine the correct prompt template for you. (basically the readme needs to contain an example of the template)
-
-If that doesn't work, you can manually select the prompt template from the dropdown. 
-
-In the case for `bartowski_Nous-Hermes-2-Mistral-7B-DPO-exl2_8_0` that is `ChatML` - select it from the dropdown and click `Save`.
-
-![Client settings](docs/img/0.21.0/selected-prompt-template.png)
-
-### Recommended Models 
-
-Any of the top models in any of the size classes here should work well (i wouldn't recommend going lower than 7B):
-
-[https://oobabooga.github.io/benchmark.html](https://oobabooga.github.io/benchmark.html)
-
-## DeepInfra via OpenAI Compatible client
-
-You can use the OpenAI compatible client to connect to [DeepInfra](https://deepinfra.com/).
-
-![DeepInfra](docs/img/0.21.0/deepinfra-setup.png)
-
-```
-API URL: https://api.deepinfra.com/v1/openai
-```
-
-Models on DeepInfra that work well with Talemate:
-
-- [mistralai/Mixtral-8x7B-Instruct-v0.1](https://deepinfra.com/mistralai/Mixtral-8x7B-Instruct-v0.1) (max context 32k, 8k recommended)
-- [cognitivecomputations/dolphin-2.6-mixtral-8x7b](https://deepinfra.com/cognitivecomputations/dolphin-2.6-mixtral-8x7b) (max context 32k, 8k recommended)
-- [lizpreciatior/lzlv_70b_fp16_hf](https://deepinfra.com/lizpreciatior/lzlv_70b_fp16_hf) (max context 4k)
-
-## Google Gemini
-
-### Google Cloud Setup
-
-Unlike the other clients the setup for Google Gemini is a bit more involved as you will need to set up a google cloud project and credentials for it.
-
-Please follow their [instructions for setup](https://cloud.google.com/vertex-ai/docs/start/client-libraries) - which includes setting up a project, enabling the Vertex AI API, creating a service account, and downloading the credentials.
-
-Once you have downloaded the credentials, copy the JSON file into the talemate directory. You can rename it to something that's easier to remember, like `my-credentials.json`.
-
-### Add the client
-
-![Google Gemini](docs/img/0.25.0/google-add-client.png)
-
-The `Disable Safety Settings` option will turn off the google reponse validation for what they consider harmful content. Use at your own risk.
-
-### Conmplete the google cloud setup in talemate
-
-![Google Gemini](docs/img/0.25.0/google-setup-incomplete.png)
-
-Click the `SETUP GOOGLE API CREDENTIALS` button that will appear on the client.
-
-The google cloud setup modal will appear, fill in the path to the credentials file and select a location that is close to you.
-
-![Google Gemini](docs/img/0.25.0/google-cloud-setup.png)
-
-Click save and after a moment the client should have a green dot next to it, indicating that it is ready to go.
-
-![Google Gemini](docs/img/0.25.0/google-ready.png)
-
-## Ready to go
-
-You will know you are good to go when the client and all the agents have a green dot next to them.
-
-![Ready to go](docs/img/0.21.0/ready-to-go.png)
-
-## Load the introductory scenario "Infinity Quest"
-
-Generated using talemate creative tools, mostly used for testing / demoing.
-
-You can load it (and any other talemate scenarios or save files) by expanding the "Load" menu in the top left corner and selecting the middle tab. Then simple search for a partial name of the scenario you want to load and click on the result.
-
-![Load scenario location](docs/img/load-scene-location.png)
-
-## Loading character cards
-
-Supports both v1 and v2 chara specs.
-
-Expand the "Load" menu in the top left corner and either click on "Upload a character card" or simply drag and drop a character card file into the same area.
-
-![Load character card location](docs/img/load-card-location.png)
-
-Once a character is uploaded, talemate may actually take a moment because it needs to convert it to a talemate format and will also run additional LLM prompts to generate character attributes and world state.
-
-Make sure you save the scene after the character is loaded as it can then be loaded as normal talemate scenario in the future.
-
-## Configure for hosting
-
-By default talemate is configured to run locally. If you want to host it behind a reverse proxy or on a server, you will need create some environment variables in the `talemate_frontend/.env.development.local` file
-
-Start by copying `talemate_frontend/example.env.development.local` to `talemate_frontend/.env.development.local`.
-
-Then open the file and edit the `ALLOWED_HOSTS` and  `VUE_APP_TALEMATE_BACKEND_WEBSOCKET_URL` variables.
-
-```sh
-ALLOWED_HOSTS=example.com
-# wss if behind ssl, ws if not
-VUE_APP_TALEMATE_BACKEND_WEBSOCKET_URL=wss://example.com:5050
-```

config.example.yaml

@@ -7,40 +7,6 @@ creator:
   - a thrilling action story
   - a mysterious adventure
   - an epic sci-fi adventure
-game:
-  world_state:
-    templates:
-      state_reinforcement:
-        Goals:
-          auto_create: false
-          description: Long term and short term goals
-          favorite: true
-          insert: conversation-context
-          instructions: Create a long term goal and two short term goals for {character_name}. Your response must only be the long terms and two short term goals.
-          interval: 20
-          name: Goals
-          query: Goals
-          state_type: npc
-        Physical Health:
-          auto_create: false
-          description: Keep track of health.
-          favorite: true
-          insert: sequential
-          instructions: ''
-          interval: 10
-          name: Physical Health
-          query: What is {character_name}'s current physical health status?
-          state_type: character
-        Time of day:
-          auto_create: false
-          description: Track night / day cycle
-          favorite: true
-          insert: sequential
-          instructions: ''
-          interval: 10
-          name: Time of day
-          query: What is the current time of day?
-          state_type: world
 
 ## Long-term memory
 

docker-compose.yml

@@ -1,27 +1,21 @@
 version: '3.8'
 
 services:
-  talemate-backend:
+  talemate:
     build:
       context: .
-      dockerfile: Dockerfile.backend
+      dockerfile: Dockerfile
+      args:
+        - CUDA_AVAILABLE=${CUDA_AVAILABLE:-false}
     ports:
-      - "5050:5050"
+      - "${FRONTEND_PORT:-8080}:8080"
+      - "${BACKEND_PORT:-5050}:5050"
     volumes:
-      # can uncomment for dev purposes
-      #- ./src/talemate:/app/src/talemate
       - ./config.yaml:/app/config.yaml
       - ./scenes:/app/scenes
       - ./templates:/app/templates
       - ./chroma:/app/chroma
     environment:
       - PYTHONUNBUFFERED=1
-  
-  talemate-frontend:
-    build:
-      context: .
-      dockerfile: Dockerfile.frontend
-    ports:
-      - "8080:8080"
-    #volumes:
-    #  - ./talemate_frontend:/app
+      - PYTHONPATH=/app/src:$PYTHONPATH
+    command: ["/bin/bash", "-c", "source /app/talemate_env/bin/activate && python src/talemate/server/run.py runserver --host 0.0.0.0 --port 5050 --frontend-host 0.0.0.0 --frontend-port 8080"]

docs/.pages

@@ -0,0 +1,5 @@
+nav:
+    - Home: index.md
+    - Getting started: getting-started
+    - User guide: user-guide
+    - Developer guide: dev

docs/chromadb.md

@@ -1,62 +0,0 @@
-# ChromaDB
-
-Talemate uses ChromaDB to maintain long-term memory. The default embeddings used are really fast but also not incredibly accurate. If you want to use more accurate embeddings you can use the instructor embeddings or the openai embeddings. See below for instructions on how to enable these.
-
-In my testing so far, instructor-xl has proved to be the most accurate (even more-so than openai)
-
-## Local instructor embeddings
-
-If you want chromaDB to use the more accurate (but much slower) instructor embeddings add the following to `config.yaml`:
-
-**Note**: The `xl` model takes a while to load even with cuda. Expect a minute of loading time on the first scene you load.
-
-```yaml
-chromadb:
-    embeddings: instructor
-    instructor_device: cpu
-    instructor_model: hkunlp/instructor-xl
-```
-
-### Instructor embedding models
-
-- `hkunlp/instructor-base` (smallest / fastest)
-- `hkunlp/instructor-large` 
-- `hkunlp/instructor-xl` (largest / slowest) - requires about 5GB of memory
-
-You will need to restart the backend for this change to take effect.
-
-**NOTE** - The first time you do this it will need to download the instructor model you selected. This may take a while, and the talemate backend will be un-responsive during that time.
-
-Once the download is finished, if talemate is still un-responsive, try reloading the front-end to reconnect. When all fails just restart the backend as well. I'll try to make this more robust in the future.
-
-### GPU support
-
-If you want to use the instructor embeddings with GPU support, you will need to install pytorch with CUDA support. 
-
-To do this on windows, run `install-pytorch-cuda.bat` from the project directory. Then change your device in the config to `cuda`:
-
-```yaml
-chromadb:
-    embeddings: instructor
-    instructor_device: cuda
-    instructor_model: hkunlp/instructor-xl
-```
-
-## OpenAI embeddings
-
-First make sure your openai key is specified in the `config.yaml` file
-
-```yaml
-openai:
-  api_key: <your-key-here>
-```
-
-Then add the following to `config.yaml` for chromadb:
-
-```yaml
-chromadb:
-    embeddings: openai
-    openai_model: text-embedding-3-small
-```
-
-**Note**: As with everything openai, using this isn't free. It's way cheaper than their text completion though. Always monitor your usage on their dashboard.

docs/dev/index.md

@@ -0,0 +1,3 @@
+# Coning soon
+
+Developer documentation is coming soon. Stay tuned! 

docs/dev/templates.md

@@ -1,4 +1,7 @@
-# Template Overrides in Talemate
+# Template Overrides
+
+!!! warning "Old documentation"
+    This is old documentation and needs to be updated, however may still contain useful information.
 
 ## Introduction to Templates
 
@@ -23,9 +26,9 @@ The creator agent templates allow for the creation of new characters within the
 
 ### Example Templates
 
-- [Character Attributes Human Template](src/talemate/prompts/templates/creator/character-attributes-human.jinja2)
-- [Character Details Human Template](src/talemate/prompts/templates/creator/character-details-human.jinja2)
-- [Character Example Dialogue Human Template](src/talemate/prompts/templates/creator/character-example-dialogue-human.jinja2)
+- `src/talemate/prompts/templates/creator/character-attributes-human.jinja2`
+- `src/talemate/prompts/templates/creator/character-details-human.jinja2`
+- `src/talemate/prompts/templates/creator/character-example-dialogue-human.jinja2`
 
 These example templates can serve as a guide for users to create their own custom templates for the character creator.
 

docs/getting-started/.pages

@@ -0,0 +1,5 @@
+nav:
+    - 1. Installation: installation
+    - 2. Connect a client: connect-a-client.md
+    - 3. Load a scene: load-a-scene.md
+    - ...

docs/getting-started/connect-a-client.md

@@ -0,0 +1,68 @@
+# Connect a client
+
+Once Talemate is up and running and you are connected, you will see a notification in the corner instructing you to configured a client.
+
+![no clients](/talemate/img/0.26.0/no-clients.png)
+
+Talemate uses client(s) to connect to local or remote AI text generation APIs like koboldcpp, text-generation-webui or OpenAI.
+
+## Add a new client
+
+On the right hand side click the **:material-plus-box: ADD CLIENT** button. 
+
+![connect a client add client](/talemate/img/0.26.0/connect-a-client-add-client.png)
+
+!!! note "No button?"
+    If there is no button, you may need to toggle the client options by clicking this button
+
+    ![open clients](/talemate/img/0.26.0/open-clients.png)
+
+The client configuration window will appear. Here you can choose the type of client you want to add.
+
+![connect a client add client modal](/talemate/img/0.26.0/connect-a-client-add-client-modal.png)
+
+## Choose an API / Client Type
+
+We have support for multiple local and remote APIs. You can choose to use one or more of them.
+
+!!! note "Local vs remote"
+    A local API runs on your machine, while a remote API runs on a server somewhere else. 
+
+Select the API you want to use and click through to follow the instructions to configure a client for it:
+
+##### Remote APIs
+
+- [OpenAI](/talemate/user-guide/clients/types/openai/)
+- [Anthropic](/talemate/user-guide/clients/types/anthropic/)
+- [mistral.ai](/talemate/user-guide/clients/types/mistral/)
+- [Cohere](/talemate/user-guide/clients/types/cohere/)
+- [Groq](/talemate/user-guide/clients/types/groq/)
+- [Google Gemini](/talemate/user-guide/clients/types/google/)
+
+##### Local APIs
+
+- [KoboldCpp](/talemate/user-guide/clients/types/koboldcpp/)
+- [Text-Generation-WebUI](/talemate/user-guide/clients/types/text-generation-webui/) 
+- [LMStudio](/talemate/user-guide/clients/types/lmstudio/)
+- [TabbyAPI](/talemate/user-guide/clients/types/tabbyapi/)
+
+##### Unofficial OpenAI API implementations
+
+- [DeepInfra](/talemate/user-guide/clients/types/openai-compatible/#deepinfra)
+- llamacpp with the `api_like_OAI.py` wrapper
+
+## Assign the client to the agents
+
+Whenever you add your first client, Talemate will automatically assign it to all agents. Once the client is configured and assigned, all agents should have a green dot next to them. (Or grey if the agent is currently disabled)
+
+![Connect a client assigned](/talemate/img/0.26.0/connect-a-client-ready.png)
+
+You can tell the client is assigned to the agent by checking the tag beneath the agent name, which will contain the client name if it is assigned.
+
+![Agent has client assigned](/talemate/img/0.26.0/agent-has-client-assigned.png)
+
+## Its not assigned!
+
+If for some reason the client is not assigned to the agent, you can manually assign it to all agents by clicking the **:material-transit-connection-variant: Assign to all agents** button.
+
+![Connect a client assign to all agents](/talemate/img/0.26.0/connect-a-client-assign-to-all-agents.png)

docs/getting-started/installation/.pages

@@ -0,0 +1,5 @@
+nav:
+    - windows.md
+    - linux.md
+    - docker.md
+    - ...

docs/getting-started/installation/docker.md

@@ -0,0 +1,22 @@
+!!! example "Experimental"
+    Talemate through docker has not received a lot of testing from me, so please let me know if you encounter any issues.
+    
+    You can do so by creating an issue on the [:material-github: GitHub repository](https://github.com/vegu-ai/talemate)
+
+## Quick install instructions
+
+1. `git clone https://github.com/vegu-ai/talemate.git`
+1. `cd talemate`
+1. copy config file
+    1. linux: `cp config.example.yaml config.yaml` 
+    1. windows: `copy config.example.yaml config.yaml`
+1. If your host has a CUDA compatible Nvidia GPU
+    1. Windows (via PowerShell): `$env:CUDA_AVAILABLE="true"; docker compose up`
+    1. Linux: `CUDA_AVAILABLE=true docker compose up`
+1. If your host does **NOT** have a CUDA compatible Nvidia GPU
+    1. Windows: `docker compose up`
+    1. Linux: `docker compose up`
+1. Navigate your browser to http://localhost:8080
+
+!!! note
+    When connecting local APIs running on the hostmachine (e.g. text-generation-webui), you need to use `host.docker.internal` as the hostname.

docs/getting-started/installation/linux.md

@@ -1,3 +1,27 @@
+
+## Quick install instructions
+
+!!! warning
+    python 3.12 is currently not supported.
+
+### Dependencies
+
+1. node.js and npm - see instructions [here](https://nodejs.org/en/download/package-manager/)
+1. python 3.10 or 3.11 - see instructions [here](https://www.python.org/downloads/)
+
+### Installation
+
+1. `git clone https://github.com/vegu-ai/talemate.git`
+1. `cd talemate`
+1. `source install.sh`
+    - When asked if you want to install pytorch with CUDA support choose `y` if you have
+        a CUDA compatible Nvidia GPU and have installed the necessary drivers.
+1. `source start.sh`
+
+If everything went well, you can proceed to [connect a client](../../connect-a-client).
+
+## Additional Information
+
 ### Setting Up a Virtual Environment
 
 1. Open a terminal.

docs/getting-started/installation/troubleshoot.md

@@ -0,0 +1,28 @@
+# Common issues
+
+## Windows
+
+### Installation fails with "Microsoft Visual C++" error
+    
+If your installation errors with a notification to upgrade "Microsoft Visual C++" go to https://visualstudio.microsoft.com/visual-cpp-build-tools/ and click "Download Build Tools" and run it.
+
+-  During installation make sure you select the C++ development package (upper left corner)
+-  Run `reinstall.bat` inside talemate directory
+
+## Docker
+
+### Docker has created `config.yaml` directory
+
+If you do not copy the example config to `config.yaml` before running `docker compose up` docker will create a `config` directory in the root of the project. This will cause the backend to fail to start.
+
+This happens because we mount the config file directly as a docker volume, and if it does not exist docker will create a directory with the same name.
+
+This will eventually be fixed, for now please make sure to copy the example config file before running the docker compose command.
+
+## General
+
+### Running behind reverse proxy with ssl
+
+Personally i have not been able to make this work yet, but its on my list, issue stems from some vue oddities when specifying the base urls while running in a dev environment. I expect once i start building the project for production this will be resolved.
+
+If you do make it work, please reach out to me so i can update this documentation.

docs/getting-started/installation/windows.md

@@ -0,0 +1,42 @@
+## Quick install instructions
+
+!!! warning
+    python 3.12 is currently not supported
+
+1. Download and install Python 3.10 or Python 3.11 from the [official Python website](https://www.python.org/downloads/windows/).
+    - [Click here for direct link to python 3.11.9 download](https://www.python.org/downloads/release/python-3119/)
+1. Download and install Node.js from the [official Node.js website](https://nodejs.org/en/download/prebuilt-installer). This will also install npm.
+1. Download the Talemate project to your local machine. Download from [the Releases page](https://github.com/vegu-ai/talemate/releases).
+1. Unpack the download and run `install.bat` by double clicking it. This will set up the project on your local machine.
+1. Once the installation is complete, you can start the backend and frontend servers by running `start.bat`.
+1. Navigate your browser to http://localhost:8080
+
+If everything went well, you can proceed to [connect a client](../../connect-a-client).
+
+## Additional Information
+
+### How to Install Python 3.10 or 3.11
+
+1. Visit the official Python website's download page for Windows at [https://www.python.org/downloads/windows/](https://www.python.org/downloads/windows/).
+2. Find the latest version of Python 3.10 or 3.11 and click on one of the download links. (You will likely want the Windows installer (64-bit))
+4. Run the installer file and follow the setup instructions. Make sure to check the box that says Add Python 3.10 to PATH before you click Install Now.
+
+### How to Install npm
+
+1. Download Node.js from the official site [https://nodejs.org/en/download/prebuilt-installer](https://nodejs.org/en/download/prebuilt-installer).
+2. Run the installer (the .msi installer is recommended).
+3. Follow the prompts in the installer (Accept the license agreement, click the NEXT button a bunch of times and accept the default installation settings).
+
+### Usage of the Supplied bat Files
+
+#### install.bat
+
+This batch file is used to set up the project on your local machine. It creates a virtual environment, activates it, installs poetry, and uses poetry to install dependencies. It then navigates to the frontend directory and installs the necessary npm packages.
+
+To run this file, simply double click on it or open a command prompt in the same directory and type `install.bat`.
+
+#### start.bat
+
+This batch file is used to start the backend and frontend servers. It opens two command prompts, one for the frontend and one for the backend.
+
+To run this file, simply double click on it or open a command prompt in the same directory and type `start.bat`.

docs/getting-started/load-a-scene.md

@@ -0,0 +1,57 @@
+# Load a scenario
+
+Once you've set up a client and assigned it to all the agents, you will be presented with the `Home` screen. From here, you can load talemate scenarios and upload character cards.
+
+To load the introductory `Infinity Quest` scenario, simply click on its entry in the `Quick Load` section.
+
+![Load infinity quest](/talemate/img/0.26.0/getting-started-load-screen.png)
+
+!!! info "First time may take a moment"
+    When you load the a scenario for the first time, Talemate will need to initialize the long term memory model. Which likely means a download. Just be patient and it will be ready soon.
+
+## Interacting with the scenario
+
+After a moment of loading, you will see the scenario's introductory message and be able to send a text interaction.
+
+![Getting stgarted scene 1](/talemate/img/0.26.0/getting-started-scene-1.png)
+
+Its time to send the first message.
+
+Spoken words should go into `"` and actions should be written in `*`. Talemate will automatically supply the other if you supply one. 
+
+![Getting started first interaction](/talemate/img/0.26.0/getting-started-first-interaction.png)
+
+Once sent, its now the AI's turn to respond - depending on the service and model selected this can take a a moment.
+
+![Getting started first ai response](/talemate/img/0.26.0/getting-started-first-ai-response.png)
+
+## Quick overview of UI elements
+
+### Scenario tools
+
+Above the chat input there is a set of tools to help you interact with the scenario.
+
+![Getting started ui element tools](/talemate/img/0.26.0/getting-started-ui-element-tools.png)
+
+These contain tools to, for example:
+
+- regenrate the most recent AI response
+- give directions to characters
+- narrate the scene
+- advance time
+- save the current scene state
+- and more ...
+
+A full guide can be found in the [Scenario Tools](/talemate/user-guide/scenario-tools) section of the user guide.
+
+### World state
+
+Shows a sumamrization of the current scene state.
+
+![getting started world state 1](/talemate/img/0.26.0/getting-started-world-state-1.png)
+
+Each item can be expanded for more information.
+
+![getting started world state 2](/talemate/img/0.26.0/getting-started-world-state-2.png)
+
+Find out more about the world state in the [World State](/talemate/user-guide/world-state) section of the user guide.