Skip to content

Commit

Permalink
fix image paths
Browse files Browse the repository at this point in the history
  • Loading branch information
vegu-ai-tools committed Jul 16, 2024
1 parent 7c5206d commit afdad84
Show file tree
Hide file tree
Showing 68 changed files with 222 additions and 222 deletions.
14 changes: 7 additions & 7 deletions docs/getting-started/connect-a-client.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,23 +2,23 @@

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](/img/0.26.0/no-clients.png)
![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 "Add Client" button. If there is no button, you may need to toggle the client options by clicking this button

![open clients](/img/0.26.0/open-clients.png)
![open clients](/talemate/img/0.26.0/open-clients.png)

Then click the **:material-plus-box: ADD CLIENT** button.

![connect a client add client](/img/0.26.0/connect-a-client-add-client.png)
![connect a client add client](/talemate/img/0.26.0/connect-a-client-add-client.png)

The client configuration modal will appear. Here you can choose the type of client you want to add.

![connect a client add client modal](/img/0.26.0/connect-a-client-add-client-modal.png)
![connect a client add client modal](/talemate/img/0.26.0/connect-a-client-add-client-modal.png)

## Choose an API / Client Type

Expand Down Expand Up @@ -53,14 +53,14 @@ Select the API you want to use and click through to follow the instructions to c

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](/img/0.26.0/connect-a-client-ready.png)
![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](/img/0.26.0/agent-has-client-assigned.png)
![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](/img/0.26.0/connect-a-client-assign-to-all-agents.png)
![Connect a client assign to all agents](/talemate/img/0.26.0/connect-a-client-assign-to-all-agents.png)
14 changes: 7 additions & 7 deletions docs/getting-started/load-a-scene.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,31 +4,31 @@ Once you've set up a client and assigned it to all the agents, you will be prese

To load the introductory `Infinity Quest` scenario, simply click on its entry in the `Quick Load` section.

![Load infinity quest](/img/0.26.0/getting-started-load-screen.png)
![Load infinity quest](/talemate/img/0.26.0/getting-started-load-screen.png)

## 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](/img/0.26.0/getting-started-scene-1.png)
![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](/img/0.26.0/getting-started-first-interaction.png)
![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](/img/0.26.0/getting-started-first-ai-response.png)
![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](/img/0.26.0/getting-started-ui-element-tools.png)
![Getting started ui element tools](/talemate/img/0.26.0/getting-started-ui-element-tools.png)

These contain tools to, for example:

Expand All @@ -45,10 +45,10 @@ A full guide can be found in the [Scenario Tools](/user-guide/scenario-tools) se

Shows a sumamrization of the current scene state.

![getting started world state 1](/img/0.26.0/getting-started-world-state-1.png)
![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](/img/0.26.0/getting-started-world-state-2.png)
![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](/user-guide/world-state) section of the user guide.
2 changes: 1 addition & 1 deletion docs/user-guide/agents/conversation/settings.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Settings

![Conversation agent settings](/img/0.26.0/conversation-agent-settings.png)
![Conversation agent settings](/talemate/img/0.26.0/conversation-agent-settings.png)

!!! note "Inference perameters"
Inference parameters are NOT configured through any individual agent.
Expand Down
2 changes: 1 addition & 1 deletion docs/user-guide/agents/director/settings.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Settings

![Director agent settings](/img/0.26.0/director-agent-settings.png)
![Director agent settings](/talemate/img/0.26.0/director-agent-settings.png)

##### Direct

Expand Down
2 changes: 1 addition & 1 deletion docs/user-guide/agents/editor/settings.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Settings

![Editor agent settings](/img/0.26.0/editor-agent-settings.png)
![Editor agent settings](/talemate/img/0.26.0/editor-agent-settings.png)

##### Fix exposition

Expand Down
2 changes: 1 addition & 1 deletion docs/user-guide/agents/narrator/settings.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Settings

![Narrator agent settings](/img/0.26.0/narrator-agent-settings.png)
![Narrator agent settings](/talemate/img/0.26.0/narrator-agent-settings.png)

##### Client

Expand Down
2 changes: 1 addition & 1 deletion docs/user-guide/agents/summarizer/settings.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Settings

![Summarizer agent settings](/img/0.26.0/summarizer-agent-settings.png)
![Summarizer agent settings](/talemate/img/0.26.0/summarizer-agent-settings.png)

##### Summarize to long term memory archive

Expand Down
2 changes: 1 addition & 1 deletion docs/user-guide/agents/visualizer/automatic1111.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Once your AUTOAMTIC1111 API is running (check with your browser) you can set the

## Settings

![Visual agent automatic1111 settings](/img/0.26.0/visual-agent-a1111-settings.png)
![Visual agent automatic1111 settings](/talemate/img/0.26.0/visual-agent-a1111-settings.png)

##### API URL

Expand Down
4 changes: 2 additions & 2 deletions docs/user-guide/agents/visualizer/comfyui.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Once your ComfyUI API is running (check with your browser) you can set the Visua

## Settings

![Visual agent comfyui settings](/img/0.26.0/visual-agent-comfyui-settings.png)
![Visual agent comfyui settings](/talemate/img/0.26.0/visual-agent-comfyui-settings.png)

##### API URL

Expand Down Expand Up @@ -46,4 +46,4 @@ When creating custom workflows for ideal compatibility with Talemate, ensure the
- A `ClipTextEncode` node named `Talemate Negative Prompt`
- A `SaveImage` node at the end of the workflow.

![ComfyUI Base workflow example](/img/0.20.0/comfyui-base-workflow.png)
![ComfyUI Base workflow example](/talemate/img/0.20.0/comfyui-base-workflow.png)
14 changes: 7 additions & 7 deletions docs/user-guide/agents/visualizer/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ The client for prompt generation can be assigned to the agent as you would for a

## Enable the Visualizer agent

![Visualizer agent disabled](/img/0.26.0/visual-agent-disabled.png)
![Visualizer agent disabled](/talemate/img/0.26.0/visual-agent-disabled.png)

If your visualizer agent is disabled - indicated by the grey dot next to the agent - you can enable it by clicking on the agent and checking the `Enable` checkbox near the top of the agent settings.

![Agent disabled](/img/0.26.0/agent-disabled.png) ![Agent enabled](/img/0.26.0/agent-enabled.png)
![Agent disabled](/talemate/img/0.26.0/agent-disabled.png) ![Agent enabled](/talemate/img/0.26.0/agent-enabled.png)


!!! abstract "Next: Configure a backend"
Expand All @@ -26,27 +26,27 @@ If your visualizer agent is disabled - indicated by the grey dot next to the age

Once enabled and configured successfully, the agent will show a green dot next to it.

![Visualizer agent enabled](/img/0.26.0/visual-agent-enabled.png)
![Visualizer agent enabled](/talemate/img/0.26.0/visual-agent-enabled.png)

At that point it will automatically enable the visualization menu for you to use (once you have a scene loaded).

![Visualization actions](/img/0.20.0/visualize-scene-tools.png)
![Visualization actions](/talemate/img/0.20.0/visualize-scene-tools.png)

Right now you can generate a portrait for any NPC in the scene or a background image for the scene itself.

Image generation by default will actually happen in the background, allowing you to continue using Talemate while the image is being generated.

You can tell if an image is being generated by the blueish spinner next to the visualization agent.

![Visualizer busy](/img/0.20.0/visualizer-busy.png)
![Visualizer busy](/talemate/img/0.20.0/visualizer-busy.png)

Once the image is generated, it will be avaible for you to view via the visual queue button on top of the screen.

![Images ready](/img/0.20.0/visualze-new-images.png)
![Images ready](/talemate/img/0.20.0/visualze-new-images.png)

Click it to open the visual queue and view the generated images.

![alt text](/img/0.20.0/visual-queue.png)
![alt text](/talemate/img/0.20.0/visual-queue.png)

### Character Portrait

Expand Down
2 changes: 1 addition & 1 deletion docs/user-guide/agents/visualizer/openai.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ You will need to have an API key and set it in the application config. See [here

## Settings

![Visual agent openai settings](/img/0.26.0/visual-agent-openai-settings.png)
![Visual agent openai settings](/talemate/img/0.26.0/visual-agent-openai-settings.png)

##### Model type

Expand Down
2 changes: 1 addition & 1 deletion docs/user-guide/agents/visualizer/settings.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Settings

![Visual agent settings](/img/0.26.0/visual-agent-settings.png)
![Visual agent settings](/talemate/img/0.26.0/visual-agent-settings.png)

##### Client

Expand Down
2 changes: 1 addition & 1 deletion docs/user-guide/agents/voice/elevenlabs.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@

If you have not configured the ElevenLabs TTS API, the voice agent will show that the API key is missing.

![Elevenlaps api key missing](/img/0.26.0/voice-agent-missing-api-key.png)
![Elevenlaps api key missing](/talemate/img/0.26.0/voice-agent-missing-api-key.png)

See the [ElevenLabs API setup](/apis/elevenlabs.md) for instructions on how to set up the API key.
10 changes: 5 additions & 5 deletions docs/user-guide/agents/voice/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@ Talemate supports Text-to-Speech (TTS) functionality, allowing users to convert

Start by enabling the voice agent, if it is currently disabled.

![Voice agent disabled](/img/0.26.0/voice-agent-disabled.png)
![Voice agent disabled](/talemate/img/0.26.0/voice-agent-disabled.png)

If your voice agent is disabled - indicated by the grey dot next to the agent - you can enable it by clicking on the agent and checking the `Enable` checkbox near the top of the agent settings.

![Agent disabled](/img/0.26.0/agent-disabled.png) ![Agent enabled](/img/0.26.0/agent-enabled.png)
![Agent disabled](/talemate/img/0.26.0/agent-disabled.png) ![Agent enabled](/talemate/img/0.26.0/agent-enabled.png)


!!! abstract "Next: Connect to a TTS api"
Expand All @@ -24,16 +24,16 @@ If your voice agent is disabled - indicated by the grey dot next to the agent -

## Select a voice

![Elevenlaps voice missing](/img/0.26.0/voice-agent-no-voice-selected.png)
![Elevenlaps voice missing](/talemate/img/0.26.0/voice-agent-no-voice-selected.png)

Click on the agent to open the agent settings.

Then click on the `Narrator Voice` dropdown and select a voice.

![Elevenlaps voice selected](/img/0.26.0/voice-agent-select-voice.png)
![Elevenlaps voice selected](/talemate/img/0.26.0/voice-agent-select-voice.png)

The selection is saved automatically, click anywhere outside the agent window to close it.

The Voice agent should now show that the voice is selected and be ready to use.

![Elevenlabs ready](/img/0.26.0/elevenlabs-ready.png)
![Elevenlabs ready](/talemate/img/0.26.0/elevenlabs-ready.png)
4 changes: 2 additions & 2 deletions docs/user-guide/agents/voice/openai.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@

If you are using OpenAI for voice generation, you will need to provide an API key.

![no api token](/img/0.26.0/no-api-token.png)
![no api token](/talemate/img/0.26.0/no-api-token.png)

See the [OpenAI API setup](/apis/openai.md) for instructions on how to set up the API key.

## Settings

![Voice agent openai settings](/img/0.26.0/voice-agent-openai-settings.png)
![Voice agent openai settings](/talemate/img/0.26.0/voice-agent-openai-settings.png)

##### Model

Expand Down
4 changes: 2 additions & 2 deletions docs/user-guide/agents/voice/settings.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Settings

![Voice agent settings](/img/0.26.0/voice-agent-settings.png)
![Voice agent settings](/talemate/img/0.26.0/voice-agent-settings.png)

##### API

Expand All @@ -14,7 +14,7 @@ The TTS API to use for voice generation.

The voice to use for narration. Each API will come with its own set of voices.

![Narrator voice](/img/0.26.0/voice-agent-select-voice.png)
![Narrator voice](/talemate/img/0.26.0/voice-agent-select-voice.png)

!!! note "Local TTS"
For local TTS, you will have to provide voice samples yourself. See [Local TTS Instructions](local_tts.md) for more information.
Expand Down
2 changes: 1 addition & 1 deletion docs/user-guide/agents/world-state/settings.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Settings

![World state agent settings](/img/0.26.0/world-state-agent-settings.png)
![World state agent settings](/talemate/img/0.26.0/world-state-agent-settings.png)

##### Update world state

Expand Down
4 changes: 2 additions & 2 deletions docs/user-guide/apis/anthropic.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ You need to have an API key for Anthropic and set it in the application config.

Once you have your key open the Talemate settings and click the `APPLICATION` tab and then the `ANTHROPIC` category. Here you can add your Anthropic API key.

![Open settings](/img/0.26.0/open-settings.png)
![Open settings](/talemate/img/0.26.0/open-settings.png)

![Set Anthropic Api Key](/img/0.26.0/anthropic-settings.png)
![Set Anthropic Api Key](/talemate/img/0.26.0/anthropic-settings.png)

Then click `Save` to save your changes.
4 changes: 2 additions & 2 deletions docs/user-guide/apis/cohere.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ You need to have an API key for Cohere and set it in the application config. You

Once you have your key open the Talemate settings and click the `APPLICATION` tab and then the `COHERE` category. Here you can add your Cohere API key.

![Open settings](/img/0.26.0/open-settings.png)
![Open settings](/talemate/img/0.26.0/open-settings.png)

![Set Cohere Api Key](/img/0.26.0/cohere-settings.png)
![Set Cohere Api Key](/talemate/img/0.26.0/cohere-settings.png)

Then click `Save` to save your changes.
4 changes: 2 additions & 2 deletions docs/user-guide/apis/elevenlabs.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ To use ElevenLabs TTS with Talemate, follow these steps:

In Talemate open the settings and click the `APPLICATION` tab and then the `ELEVENLABS` category. Here you can add your ElevenLabs API key.

![Open settings](/img/0.26.0/open-settings.png)
![Open settings](/talemate/img/0.26.0/open-settings.png)

![Runpod settings](/img/0.26.0/elevenlabs-settings.png)
![Runpod settings](/talemate/img/0.26.0/elevenlabs-settings.png)

Click `Save` to save your changes.

Expand Down
4 changes: 2 additions & 2 deletions docs/user-guide/apis/google.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ Please follow their [instructions for setup](https://cloud.google.com/vertex-ai/

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 `creds.json`.

![Open settings](/img/0.26.0/open-settings.png)
![Open settings](/talemate/img/0.26.0/open-settings.png)

![Set Google creds](/img/0.26.0/google-settings.png)
![Set Google creds](/talemate/img/0.26.0/google-settings.png)

Then click `Save` to save your changes.

Expand Down
4 changes: 2 additions & 2 deletions docs/user-guide/apis/groq.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ You need to have an API key for Groq and set it in the application config. You c

Once you have your key open the Talemate settings and click the `APPLICATION` tab and then the `GROQ` category. Here you can add your Groq API key.

![Open settings](/img/0.26.0/open-settings.png)
![Open settings](/talemate/img/0.26.0/open-settings.png)

![Set Groq Api Key](/img/0.26.0/groq-settings.png)
![Set Groq Api Key](/talemate/img/0.26.0/groq-settings.png)

Then click `Save` to save your changes.
4 changes: 2 additions & 2 deletions docs/user-guide/apis/mistral.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ You need to have an API key for Mistral.ai and set it in the application config.

Once you have your key open the Talemate settings and click the `APPLICATION` tab and then the `MISTRAL.AI` category. Here you can add your Mistral.ai API key.

![Open settings](/img/0.26.0/open-settings.png)
![Open settings](/talemate/img/0.26.0/open-settings.png)

![Set Mistral.ai Api Key](/img/0.26.0/mistral-settings.png)
![Set Mistral.ai Api Key](/talemate/img/0.26.0/mistral-settings.png)

Then click `Save` to save your changes.
4 changes: 2 additions & 2 deletions docs/user-guide/apis/openai.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ You need to have an API key for OpenAI and set it in the application config. You

Once you have your key open the Talemate settings and click the `APPLICATION` tab and then the `OPENAI` category. Here you can add your OpenAI API key.

![Open settings](/img/0.26.0/open-settings.png)
![Open settings](/talemate/img/0.26.0/open-settings.png)

![Set OpenAI Api Key](/img/0.26.0/openai-settings.png)
![Set OpenAI Api Key](/talemate/img/0.26.0/openai-settings.png)

Then click `Save` to save your changes.
Loading

0 comments on commit afdad84

Please sign in to comment.