From 06dc7b6428dda9744311af25bf4f656fcb00a8a2 Mon Sep 17 00:00:00 2001 From: vegu-ai-tools <152010387+vegu-ai-tools@users.noreply.github.com> Date: Sun, 7 Jun 2026 18:46:56 +0300 Subject: [PATCH] docs --- docs/snippets/common.md | 4 ++-- docs/snippets/tips.md | 2 +- .../user-guide/howto/create-a-new-scene/create-empty-scene.md | 2 +- docs/user-guide/scenario-tools.md | 4 ++-- docs/user-guide/scene-directory.md | 2 +- docs/user-guide/{world-editor => }/templates/.pages | 0 docs/user-guide/{world-editor => }/templates/attribute.md | 2 +- docs/user-guide/{world-editor => }/templates/detail.md | 2 +- docs/user-guide/{world-editor => }/templates/groups.md | 0 docs/user-guide/{world-editor => }/templates/index.md | 4 ++-- docs/user-guide/{world-editor => }/templates/scene_type.md | 0 docs/user-guide/{world-editor => }/templates/spice.md | 2 +- docs/user-guide/{world-editor => }/templates/state.md | 4 ++-- docs/user-guide/{world-editor => }/templates/writing-style.md | 0 docs/user-guide/tracking-a-state.md | 4 ++-- docs/user-guide/world-editor/characters/attributes.md | 2 +- docs/user-guide/world-editor/characters/details.md | 2 +- docs/user-guide/world-editor/characters/index.md | 2 +- docs/user-guide/world-editor/characters/states.md | 4 ++-- docs/user-guide/world-editor/generation-settings.md | 4 ++-- docs/user-guide/world-editor/scene/direction.md | 2 +- docs/user-guide/world-editor/scene/settings.md | 2 +- docs/user-guide/world-editor/world/states.md | 4 ++-- 23 files changed, 27 insertions(+), 27 deletions(-) rename docs/user-guide/{world-editor => }/templates/.pages (100%) rename docs/user-guide/{world-editor => }/templates/attribute.md (98%) rename docs/user-guide/{world-editor => }/templates/detail.md (97%) rename docs/user-guide/{world-editor => }/templates/groups.md (100%) rename docs/user-guide/{world-editor => }/templates/index.md (94%) rename docs/user-guide/{world-editor => }/templates/scene_type.md (100%) rename docs/user-guide/{world-editor => }/templates/spice.md (98%) rename docs/user-guide/{world-editor => }/templates/state.md (96%) rename docs/user-guide/{world-editor => }/templates/writing-style.md (100%) diff --git a/docs/snippets/common.md b/docs/snippets/common.md index 2fffd6ac..5782ad8d 100644 --- a/docs/snippets/common.md +++ b/docs/snippets/common.md @@ -4,7 +4,7 @@ -Fist, if you have not done so, [create a template group](/talemate/user-guide/world-editor/templates/groups) to store the template in. +Fist, if you have not done so, [create a template group](/talemate/user-guide/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. @@ -15,7 +15,7 @@ Then select the group you want to add the template to and click the **:material- !!! note "Unwanted Prose Requirement" Unwanted phrases are defined in the writing style that is currently selected in the [Scene Settings](/talemate/user-guide/world-editor/scene/settings). - See [Writing Style Templates](/talemate/user-guide/world-editor/templates/writing-style) for more information on how to create a writing style and add unwanted phrases. + See [Writing Style Templates](/talemate/user-guide/templates/writing-style) for more information on how to create a writing style and add unwanted phrases. diff --git a/docs/snippets/tips.md b/docs/snippets/tips.md index 2abf1335..e5fe1fab 100644 --- a/docs/snippets/tips.md +++ b/docs/snippets/tips.md @@ -21,7 +21,7 @@ !!! tip "Generation settings and managing templates" - Find out more about content generation, managing templates and how to apply randomization and specific writing styles in [Templates](/talemate/user-guide/world-editor/templates/) and [Generation settings](/talemate/user-guide/world-editor/generation-settings). + Find out more about content generation, managing templates and how to apply randomization and specific writing styles in [Templates](/talemate/user-guide/templates/) and [Generation settings](/talemate/user-guide/world-editor/generation-settings). diff --git a/docs/user-guide/howto/create-a-new-scene/create-empty-scene.md b/docs/user-guide/howto/create-a-new-scene/create-empty-scene.md index 34924d54..ce438ff0 100644 --- a/docs/user-guide/howto/create-a-new-scene/create-empty-scene.md +++ b/docs/user-guide/howto/create-a-new-scene/create-empty-scene.md @@ -8,7 +8,7 @@ After a moment of loading you will be taken to the new scene and `creative` mode ## Create the outline for the scene ---8<-- "docs/talemate/user-guide/world-editor/scene/outline.md:outline" +--8<-- "docs/user-guide/world-editor/scene/outline.md:outline" ## Save the scene diff --git a/docs/user-guide/scenario-tools.md b/docs/user-guide/scenario-tools.md index c0e1dd72..7b5852a9 100644 --- a/docs/user-guide/scenario-tools.md +++ b/docs/user-guide/scenario-tools.md @@ -197,7 +197,7 @@ Allows you to quickly set up tracked character and world states. !!! info "What is a tracked state?" - --8<-- "docs/talemate/user-guide/tracking-a-state.md:what-is-a-tracked-state" + --8<-- "docs/user-guide/tracking-a-state.md:what-is-a-tracked-state" Please refer to the [World State](/talemate/user-guide/world-state) section for more information on how set up custom states to track. @@ -286,7 +286,7 @@ Write direction on how you want the character to enter the scene. ##### Templates -Control attribute generation using your existing [World State Templates](/talemate/user-guide/world-editor/templates). +Control attribute generation using your existing [World State Templates](/talemate/user-guide/templates). ![Select templates](/talemate/img/0.30.0/scene-tool-intro-char-templates.png) diff --git a/docs/user-guide/scene-directory.md b/docs/user-guide/scene-directory.md index e58516fc..ccebc99e 100644 --- a/docs/user-guide/scene-directory.md +++ b/docs/user-guide/scene-directory.md @@ -49,7 +49,7 @@ Stores [node editor](/talemate/user-guide/node-editor/) graphs for the scene, su ### `templates/` -Scene-specific [templates](/talemate/user-guide/world-editor/templates/writing-style/) that override or extend the default templates. These are organized into `scene/`, `common/`, and agent-specific subdirectories. +Scene-specific [templates](/talemate/user-guide/templates/writing-style/) that override or extend the default templates. These are organized into `scene/`, `common/`, and agent-specific subdirectories. ### `shared-context/` diff --git a/docs/user-guide/world-editor/templates/.pages b/docs/user-guide/templates/.pages similarity index 100% rename from docs/user-guide/world-editor/templates/.pages rename to docs/user-guide/templates/.pages diff --git a/docs/user-guide/world-editor/templates/attribute.md b/docs/user-guide/templates/attribute.md similarity index 98% rename from docs/user-guide/world-editor/templates/attribute.md rename to docs/user-guide/templates/attribute.md index 80a82915..4debdc5f 100644 --- a/docs/user-guide/world-editor/templates/attribute.md +++ b/docs/user-guide/templates/attribute.md @@ -6,7 +6,7 @@ They are used in the [Character Editor - Attributes](/talemate/user-guide/world- ## Creating a character attribute template -Fist, if you have not done so, [create a template group](/talemate/user-guide/world-editor/templates/groups) to store the template in. +Fist, if you have not done so, [create a template group](/talemate/user-guide/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. diff --git a/docs/user-guide/world-editor/templates/detail.md b/docs/user-guide/templates/detail.md similarity index 97% rename from docs/user-guide/world-editor/templates/detail.md rename to docs/user-guide/templates/detail.md index f13325f6..356dca0a 100644 --- a/docs/user-guide/world-editor/templates/detail.md +++ b/docs/user-guide/templates/detail.md @@ -6,7 +6,7 @@ They are used in the [Character Editor - Details](/talemate/user-guide/world-edi ## Creating a character detail template -Fist, if you have not done so, [create a template group](/talemate/user-guide/world-editor/templates/groups) to store the template in. +Fist, if you have not done so, [create a template group](/talemate/user-guide/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. diff --git a/docs/user-guide/world-editor/templates/groups.md b/docs/user-guide/templates/groups.md similarity index 100% rename from docs/user-guide/world-editor/templates/groups.md rename to docs/user-guide/templates/groups.md diff --git a/docs/user-guide/world-editor/templates/index.md b/docs/user-guide/templates/index.md similarity index 94% rename from docs/user-guide/world-editor/templates/index.md rename to docs/user-guide/templates/index.md index f5eb5cee..d7e7eb05 100644 --- a/docs/user-guide/world-editor/templates/index.md +++ b/docs/user-guide/templates/index.md @@ -1,6 +1,6 @@ -# World Editor Templates +# Templates -Open the **:material-earth-box: World Editor** and select the **:material-cube-scan: Templates** tab to manage templates. +Click the **:material-cube-scan: Templates** tab in the top navigation bar to manage templates. These templates are used to facilitate the generation of content for your game. They can be used to define character attributes, character details, writing styles, and automated world or character state tracking. diff --git a/docs/user-guide/world-editor/templates/scene_type.md b/docs/user-guide/templates/scene_type.md similarity index 100% rename from docs/user-guide/world-editor/templates/scene_type.md rename to docs/user-guide/templates/scene_type.md diff --git a/docs/user-guide/world-editor/templates/spice.md b/docs/user-guide/templates/spice.md similarity index 98% rename from docs/user-guide/world-editor/templates/spice.md rename to docs/user-guide/templates/spice.md index e9a0f94c..538ad108 100644 --- a/docs/user-guide/world-editor/templates/spice.md +++ b/docs/user-guide/templates/spice.md @@ -4,7 +4,7 @@ Spice collections are used to define a set of instructions that can be applied d ## Creating a spice collection -Fist, if you have not done so, [create a template group](/talemate/user-guide/world-editor/templates/groups) to store the template in. +Fist, if you have not done so, [create a template group](/talemate/user-guide/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. diff --git a/docs/user-guide/world-editor/templates/state.md b/docs/user-guide/templates/state.md similarity index 96% rename from docs/user-guide/world-editor/templates/state.md rename to docs/user-guide/templates/state.md index ad2651a5..dda2663b 100644 --- a/docs/user-guide/world-editor/templates/state.md +++ b/docs/user-guide/templates/state.md @@ -7,7 +7,7 @@ They are used in the [Character Editor - Tracked States](/talemate/user-guide/wo ## Creating a state reinforcement template -Fist, if you have not done so, [create a template group](/talemate/user-guide/world-editor/templates/groups) to store the template in. +Fist, if you have not done so, [create a template group](/talemate/user-guide/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. @@ -61,7 +61,7 @@ Specifies what type of object the state is attached to, currently this can be ### Context Attachment Method ---8<-- "docs/talemate/user-guide/tracking-a-state.md:context-attachment-method" +--8<-- "docs/user-guide/tracking-a-state.md:context-attachment-method" ### Update every `N` turns diff --git a/docs/user-guide/world-editor/templates/writing-style.md b/docs/user-guide/templates/writing-style.md similarity index 100% rename from docs/user-guide/world-editor/templates/writing-style.md rename to docs/user-guide/templates/writing-style.md diff --git a/docs/user-guide/tracking-a-state.md b/docs/user-guide/tracking-a-state.md index 4524a331..6d475b18 100644 --- a/docs/user-guide/tracking-a-state.md +++ b/docs/user-guide/tracking-a-state.md @@ -37,9 +37,9 @@ Then follow the instructions at [Tracking a world state](/talemate/user-guide/wo ## Quickly apply often tracked states via templates ---8<-- "docs/talemate/user-guide/scenario-tools.md:tools-ux" +--8<-- "docs/user-guide/scenario-tools.md:tools-ux" ---8<-- "docs/talemate/user-guide/scenario-tools.md:quick-apply-favorite-state" +--8<-- "docs/user-guide/scenario-tools.md:quick-apply-favorite-state" ## Context Attachment Method diff --git a/docs/user-guide/world-editor/characters/attributes.md b/docs/user-guide/world-editor/characters/attributes.md index bced68ab..762d4404 100644 --- a/docs/user-guide/world-editor/characters/attributes.md +++ b/docs/user-guide/world-editor/characters/attributes.md @@ -37,7 +37,7 @@ You will be asked to confirm the removal. Press the **:material-close-box-outlin ## Generating attributes using templates -You can use [templates](/talemate/user-guide/world-editor/templates/attribute) to quickly generate attributes for your characters. +You can use [templates](/talemate/user-guide/templates/attribute) to quickly generate attributes for your characters. In the **Attributes** tab, click the **:material-cube-scan: Templates** button above the attribute list to expand the templates list. diff --git a/docs/user-guide/world-editor/characters/details.md b/docs/user-guide/world-editor/characters/details.md index abc1a5f4..d6f0739a 100644 --- a/docs/user-guide/world-editor/characters/details.md +++ b/docs/user-guide/world-editor/characters/details.md @@ -63,7 +63,7 @@ If a pin already exists for the selected detail, the button will display :materi ## Generating details using templates -You can use [templates](/talemate/user-guide/world-editor/templates/detail) to quickly generate details for your characters. +You can use [templates](/talemate/user-guide/templates/detail) to quickly generate details for your characters. In the **Details** tab, click the **:material-cube-scan: Templates** button above the detail list to expand the templates list. diff --git a/docs/user-guide/world-editor/characters/index.md b/docs/user-guide/world-editor/characters/index.md index 585a41e4..7b8d396b 100644 --- a/docs/user-guide/world-editor/characters/index.md +++ b/docs/user-guide/world-editor/characters/index.md @@ -30,7 +30,7 @@ When a **:material-image-auto-adjust: state reinforcment** is updated the value ### :material-image-auto-adjust: [Tracked states](/talemate/user-guide/world-editor/characters/states) ---8<-- "docs/talemate/user-guide/tracking-a-state.md:what-is-a-tracked-state" +--8<-- "docs/user-guide/tracking-a-state.md:what-is-a-tracked-state" ### :material-bullhorn: [Actor management](/talemate/user-guide/world-editor/characters/actor) diff --git a/docs/user-guide/world-editor/characters/states.md b/docs/user-guide/world-editor/characters/states.md index 5a2376a2..fe758d7f 100644 --- a/docs/user-guide/world-editor/characters/states.md +++ b/docs/user-guide/world-editor/characters/states.md @@ -2,7 +2,7 @@ !!! info "What is a tracked state?" - --8<-- "docs/talemate/user-guide/tracking-a-state.md:what-is-a-tracked-state" + --8<-- "docs/user-guide/tracking-a-state.md:what-is-a-tracked-state" ## Setting up a new state In the :material-account-group: **Character** editor select the character you want to add a new state to. @@ -43,7 +43,7 @@ By default it will be `10` turns, but you can change this to any number you like ### Context Attachment Method ---8<-- "docs/talemate/user-guide/tracking-a-state.md:context-attachment-method" +--8<-- "docs/user-guide/tracking-a-state.md:context-attachment-method" ### Additional Instructions diff --git a/docs/user-guide/world-editor/generation-settings.md b/docs/user-guide/world-editor/generation-settings.md index 6ef4928c..b05ff008 100644 --- a/docs/user-guide/world-editor/generation-settings.md +++ b/docs/user-guide/world-editor/generation-settings.md @@ -70,7 +70,7 @@ The remembered lengths include: Allows you to apply a writing style to AI generated content. -Writing styles are managed through [:material-script-text: writing style templates](/talemate/user-guide/world-editor/templates/writing-style). +Writing styles are managed through [:material-script-text: writing style templates](/talemate/user-guide/templates/writing-style). Once there is a writing style template available, you can select it from the dropdown list. @@ -80,7 +80,7 @@ Once there is a writing style template available, you can select it from the dro Spice is a way to add some controlled randomness to AI generated content. -Spices are managed through [:material-chili-mild: spice collection templates](/talemate/user-guide/world-editor/templates/spice). +Spices are managed through [:material-chili-mild: spice collection templates](/talemate/user-guide/templates/spice). Once there is a spice template available, you can select it from the dropdown list. diff --git a/docs/user-guide/world-editor/scene/direction.md b/docs/user-guide/world-editor/scene/direction.md index 555ddc93..31bc7b8c 100644 --- a/docs/user-guide/world-editor/scene/direction.md +++ b/docs/user-guide/world-editor/scene/direction.md @@ -46,7 +46,7 @@ This allows to differentiate between, for example `roleplay` or `combat` scenes, !!! 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) +Re-usable scene types can be created in the [Template Editor](/talemate/user-guide/templates) #### Current Scene Intention diff --git a/docs/user-guide/world-editor/scene/settings.md b/docs/user-guide/world-editor/scene/settings.md index 25c7315c..0e5adc4e 100644 --- a/docs/user-guide/world-editor/scene/settings.md +++ b/docs/user-guide/world-editor/scene/settings.md @@ -6,7 +6,7 @@ The `Settings` tab allows you to configure various settings for the scene. ### Writing Style -If you have any [writing style templates](/talemate/user-guide/world-editor/templates/writing-style/) set up, you can select one here. Some agents may use this to influence their output. +If you have any [writing style templates](/talemate/user-guide/templates/writing-style/) set up, you can select one here. Some agents may use this to influence their output. ### Locked save file diff --git a/docs/user-guide/world-editor/world/states.md b/docs/user-guide/world-editor/world/states.md index fec9544f..702dd9c5 100644 --- a/docs/user-guide/world-editor/world/states.md +++ b/docs/user-guide/world-editor/world/states.md @@ -2,7 +2,7 @@ !!! info "What is a tracked state?" - --8<-- "docs/talemate/user-guide/tracking-a-state.md:what-is-a-tracked-state" + --8<-- "docs/user-guide/tracking-a-state.md:what-is-a-tracked-state" ## Setting up a new state In the :material-earth: **World** editor, in the left panel, click the :material-image-auto-adjust: **New State Reinforcement** button. @@ -33,7 +33,7 @@ By default it will be `10` turns, but you can change this to any number you like ### Context Attachment Method ---8<-- "docs/talemate/user-guide/tracking-a-state.md:context-attachment-method" +--8<-- "docs/user-guide/tracking-a-state.md:context-attachment-method" For this example, we always want to know the state of the ship, so we will set it to `All context`.