docs

docs/snippets/common.md

@@ -1,4 +1,12 @@
 <!--- --8<-- [start:python-versions] -->
 !!! note "Supported Versions"
     As of Talemate `0.30` the following python versions are supported: `3.10`, `3.11`, `3.12` or `3.13`
-<!--- --8<-- [end:python-versions] -->
+<!--- --8<-- [end:python-versions] -->
+
+<!--- --8<-- [start:world-editor-create-group] -->
+Fist, if you have not done so, [create a template group](/talemate/user-guide/world-editor/templates/groups) to store the template in.
+
+Then select the group you want to add the template to and click the **:material-plus: Create Template** button.
+
+![world editor templates create attribute template 1](/talemate/img/0.26.0/world-editor-templates-create-attribute-template-1.png)
+<!--- --8<-- [end:world-editor-create-group] -->

docs/user-guide/agents/conversation/index.md

@@ -1,5 +1,5 @@
 # Overview
 
-The conversation agent drives the AI generated dialogue.
+Also known as the **Actor** agent it is responsible for generating character driven dialogue and actions.
 
-It rquires a text-generation client to be configured and assigned.
+It requires a text-generation client to be configured and assigned.

docs/user-guide/agents/conversation/settings.md

@@ -2,7 +2,7 @@
 
 ## General
 
-![Conversation agent general settings](/talemate/img/0.29.0/conversation-general-settings.png)
+![Conversation agent general settings](/talemate/img/0.30.0/conversation-general-settings.png)
 
 !!! note "Inference perameters"
     Inference parameters are NOT configured through any individual agent.
@@ -17,17 +17,11 @@ The text-generation client to use for conversation generation.
 
 If checked and talemate detects a repetitive response (based on a threshold), it will automatically re-generate the resposne with increased randomness parameters.
 
-##### Natural Flow
+!!! note "Deprecated"
+    This will soon be removed in favor of the new [Editor Agent Revision Action](/talemate/user-guide/agents/editor/settings#revision)
 
-When there are multiple characters in the scene, this will help the AI to keep the conversation flowing naturally, making sure turns are somewhat evenly distributed, and also checking that the most relevant character gets the next turn, based on the context.
+!!! note "Natural flow was moved"
-
+    The natural flow settings have been moved to the [Director Agent](/talemate/user-guide/agents/director) settings as part of the auto direction feature.
-##### Max. Auto turns
-
-Maximum turns the AI gets in succession, before the player gets a turn no matter what.
-
-##### Max. Idle turns
-
-The maximum number of turns a character can go without speaking before the AI will force them to speak.
 
 ## Generation
 
@@ -64,6 +58,14 @@ General, broad isntructions for ALL actors in the scene. This will be appended t
 
 If > 0 will offset the instructions for the actor (both broad and character specific) into the history by that many turns. Some LLMs struggle to generate coherent continuations if the scene is interrupted by instructions right before the AI is asked to generate dialogue. This allows to shift the instruction backwards.
 
+## :material-script-text: Content
+
+![Conversation agent content settings](/talemate/img/0.30.0/conversation-content-settings.png)
+
+Enable this setting to apply a writing style to the generated content.
+
+Make sure the a writing style is selected in the [Scene Settings](/talemate/user-guide/world-editor/scene/settings) to apply the writing style to the generated content.
+
 ## Long Term Memory
 
 --8<-- "docs/snippets/tips.md:agent_long_term_memory_settings"

docs/user-guide/agents/creator/index.md

@@ -1,5 +1,3 @@
 # Overview
 
-The creator agent is responsible for creating the AI generated content. It requires a text-generation client to be configured and assigned.
+Used tor most creative tasks that involves the creation of new context.
-
-Currently exposes no settings to configure the agent itself.

docs/user-guide/agents/creator/settings.md

@@ -0,0 +1,21 @@
+# Settings
+
+Open by clicking the **Creator** agent in the agent list.
+
+![Creator agent item](/talemate/img/0.30.0/creator-agent-item.png)
+
+## Long Term Memory
+
+--8<-- "docs/snippets/tips.md:agent_long_term_memory_settings"
+
+## Autocomplete
+
+![Conversation agent autocomplete settings](/talemate/img/0.30.0/creator-autocomplete-settings.png)
+
+##### Dialogue Suggestion Length
+
+How many tokens to generate (max.) when autocompleting character actions.
+
+##### Narrative Suggestion Length
+
+How many tokens to generate (max.) when autocompleting narrative text.

docs/user-guide/agents/director/index.md

@@ -7,4 +7,10 @@ In the future it will shift / expose more of a game master role, controlling the
 Will occasionally generate clickable choices for the user during scene progression. This can be used to allow the user to make choices that will affect the scene or the story in some way without having to manually type out the choice.
 
 ### Guide Scene
-Will use the summarizer agent's scene analysis to guide characters and the narrator for the next generation, hopefully improving the quality of the generated content.
+Will use the summarizer agent's scene analysis to guide characters and the narrator for the next generation, hopefully improving the quality of the generated content.
+
+### Auto Direction
+A very experimental feature that will cause the director to attempt to direct the scene automatically, instructing actors or the narrator to move the scene forward according to the story and scene intention.
+
+!!! note "Experimental"
+    This is the first iteration of this feature and is very much a work in progress. It will likely change substantially in the future.

docs/user-guide/agents/director/settings.md

@@ -88,4 +88,70 @@ If enabled the director will guide the narrator in the scene.
 
 ##### Max. Guidance Length
 
-The maximum number of tokens for the guidance. (e.g., how long should the guidance be).
+The maximum number of tokens for the guidance. (e.g., how long should the guidance be).
+
+## Auto Direction
+
+A very experimental first attempt at giving the reigns to the director to direct the scene automatically.
+
+Currently it can only instruct actors and the narrator, but different actions will be exposed in the future. This is very early in the development cycle and will likely go through substantial changes.
+
+!!! note "Both overall and current intent need to be set for auto-direction to be available"
+    If either the overall or current scene intention is not set, the auto-direction feature will not be available.
+
+    ![Auto Direction Unavailable](/talemate/img/0.30.0/auto-direction-unavailable.png)
+
+    Story and scene intentions are set in the [Scene Direction](/talemate/user-guide/world-editor/scene/direction) section of the World Editor.
+
+![Director agent auto direction settings](/talemate/img/0.30.0/director-auto-direction-settings.png)
+
+##### Enable Auto Direction
+
+Turn auto direction on and off. 
+
+!!! note "Auto progress needs to also be enabled"
+    If auto direction is enabled, auto progress needs to be enabled as well.
+
+    ![Auto Progress On](/talemate/img/0.30.0/auto-progress-on.png)
+#### Natural flow
+
+Will place strict limits on actor turns based on the provided constraints. That means regardless of what the director would like to do, the actor availability will always take precedence.
+
+##### Max. Auto turns
+
+Maximum turns the AI gets in succession (spread accross characters). When this limit is reached, the player will get a turn no matter what.
+
+##### Max. Idle turns
+
+The maximum number of turns a character can go without speaking before they are automatically given a turn by the director. (per character)
+
+##### Max. Repeat Turns
+
+The maximum number of times a character can go in succession without speaking before the director will force them to speak. (per character)
+
+
+#### Instructions
+
+##### Instruct Actors
+
+Allow the director to instruct actors.
+
+##### Instruct Narrator
+
+Allow the director to instruct the narrator.
+
+##### Instruct Frequency
+
+Only pass on instructions to the actors or the narrator every N turns.
+
+!!! note "Evaluation of the scene happens regardless"
+    The director will evaluate the scene after each round regardless of the frequency. This setting merely controls how often the instructions are actually passed on.
+
+##### Evaluate Scene Intention
+
+Allows the director to evaluate the current scene phase and switch to a different scene type or set a new intention.
+
+The number of turns between evaluations. (0 = NEVER)
+
+!!! note "Recommended to leave at 0 (never)"
+    This isn't really working well at this point, so recommended to leave at 0 (never)

docs/user-guide/agents/index.md

@@ -14,6 +14,10 @@ Used for creative tasks like scene and character generation
 
 Will eventually become a Game Master type agent. Right now used for some very rudimentary scene direction. Allows complex scene control via the scoped api scripting.
 
+### Editor
+
+Will try to correct markup and optionally revise text to fix repetition and unwanted prose.
+
 ### Long-term Memory
 
 Attempts to select and add relevant information to the current context window.

docs/user-guide/interacting.md

@@ -53,6 +53,9 @@ When typing out your action / dialogue, you can hit the `ctrl+enter` key combina
 
     See [Prompt Templates](/talemate/user-guide/clients/prompt-templates) for more information.
 
+!!! note "Generation length"
+    The amount of text generated can be configured through the [Creator Agent Settings](/talemate/user-guide/agents/creator/settings)
+
 ## Auto progress
 
 By default Talemate will give the next turn to the AI after you have sent a message, automatically progressing the scene.

docs/user-guide/world-editor/scene/.pages

@@ -1,4 +1,5 @@
 nav:
     - Outline: outline.md
+    - Direction: direction.md
     - Settings: settings.md
     - Export: export.md

docs/user-guide/world-editor/scene/direction.md

@@ -0,0 +1,44 @@
+## Direction
+
+Allows you to define an overall intention of the story as well as a more specific intention for the current scene.
+
+This mostly used for the director's auto-direction feature, but may also affect the director's scene guidance actions.
+
+!!! note "Both overall and current intent need to be set for auto-direction to be available"
+    If either the overall or current scene intention is not set, the auto-direction feature will not be available.
+
+    ![Auto Direction Unavailable](/talemate/img/0.30.0/auto-direction-unavailable.png)
+
+### :material-compass: Overall Intention
+
+The overall intention guides the director when making decisions that require a bigger picture context.
+
+It should state what the goal and expections of the experience should be.
+
+### :material-flag: Current Phase
+
+Defines the type and intention of the current scene (phase).
+
+#### Scene Type
+
+The scene type defines general instructions for the type of scene that is currently being played.
+
+This allows to differentiate between, for example `roleplay` or `combat` scenes, which may require different handling by the director.
+
+!!! warning "Very early WIP"
+    This is a very unfinished feature, so don't expect that you can plugin in some D&D style turn based combat rules into a scene type and have it work. Right now it will mostly affect the type of text that is generated and the pacing of the scene.
+
+Re-usable scene types can be created in the [Template Editor](/talemate/user-guide/world-editor/templates)
+
+#### Current Scene Intention
+
+Should describe the specific intention (goal) of the current scene.
+
+Currently this is free-form instructions and still under strong review as to figuree out what works well, but generally speaking here is a good guideline:
+
+- Define the characters involved, their location and the general setting of the scene.
+- The intention of the scene
+- Define one or more goals that would cause the scene to be considered successful / complete.
+- Any important notes about the scene that should be remembered.
+
+

docs/user-guide/world-editor/templates/index.md

@@ -23,4 +23,7 @@ Spice collections are used to define a set of instructions that can be applied d
 Writing style templates are used to define a writing style that can be applied to the generated content. They can be used to add a specific flavor or tone. A template must explicitly support writing styles to be able to use a writing style template.
 
 ### :material-image-auto-adjust: State Reinforcement
-State reinforcement templates are used to quickly (or even automatically) setup common attribues and states you want to track for characters or the world itself. They revolve around a question, statement or attribute name that you want to track for a character. The AI will use this template to generate content that matches the query, based on the current progression of the scene.
+State reinforcement templates are used to quickly (or even automatically) setup common attribues and states you want to track for characters or the world itself. They revolve around a question, statement or attribute name that you want to track for a character. The AI will use this template to generate content that matches the query, based on the current progression of the scene.
+
+### :material-movie-open: Scene Type
+Scene type templates are used to define different types of scenes that can be played in your game. Each scene type has different rules and constraints that guide the generation and flow of the scene.

docs/user-guide/world-editor/templates/scene_type.md

@@ -0,0 +1,46 @@
+# Scene Types
+
+Scene type templates are used to define different types of scenes that can be played in your game. Each scene type has different rules and constraints that guide the generation and flow of the scene.
+
+## Creating a scene type
+
+--8<-- "docs/snippets/common.md:world-editor-create-group"
+
+Next enter a template name and select **Scene type** as a template type.
+
+### Template name
+
+The name / label of the template. This is the name that will be displayed in the list of templates.
+
+### Template type
+
+Specify the type of template you are creating. In this case, select **Scene type**.
+
+![world editor templates create scene type template 1](/talemate/img/0.30.0/create-template-scene-type.png)
+
+### Template description
+
+A longer description of the template. What is the purpose of the template? What should it be used for?
+
+### Scene type instructions
+
+This should be the actual scene type instructions that govern the director's actions when a scene of this type is played.
+
+!!! warning "Very early WIP"
+    This is a very early WIP - right now do not expect this to do anything but control style and pacing. Eventually this would be where more complicated rules could be defined to guide the progress of the scene. (Turn based combat, etc.)
+    
+    We're not quite there yet.
+
+### Favorite
+
+Mark the template as a favorite to make it easier to find in the list of templates.
+
+Favorited templates will be shown at the top of the list of templates.
+
+## Create the template
+
+When you have filled out the form, click the **:material-cube-scan: Create Template** button to create the template.
+
+## Using the scene type template
+
+Right now the only place **Scene Type** templates are used is in the [Scene Direction](/talemate/user-guide/world-editor/scene/direction) section of the World Editor, where you can import scene types from these templates.

docs/user-guide/world-editor/templates/writing-style.md

@@ -4,11 +4,7 @@ Writing style templates are used to define a writing style that can be applied t
 
 ## Creating a writing style
 
-Fist, if you have not done so, [create a template group](/talemate/user-guide/world-editor/templates/groups) to store the template in.
+--8<-- "docs/snippets/common.md:world-editor-create-group"
-
-Then select the group you want to add the template to and click the **:material-plus: Create Template** button.
-
-![world editor templates create attribute template 1](/talemate/img/0.26.0/world-editor-templates-create-attribute-template-1.png)
 
 Next enter a template name and select **Writing style** as a template type.