talemate/docs/user-guide/scenario-tools.md
veguAI 95a17197ba
0.26.0 (#133)
* implement manually disabling and enabling clients

* relock

* fix warning spam

* start moving stuff around

* move more stuff

* start separating world state manager into more managable submodules

* character title

* scroll home to top always

* finish separating character state editor into components

* fix defered nav to character sections

* separate components for pin and contextdb managing

* fix issue with context character filter search

* fix world state manage ux state reset issues

* wsm menu refactor
allow updating character image from wsm
cover image layout fixes

* remove debug spam

* fix client deletion / disabling rubber banding issue

* deactivate / activate / delete characters through wsm

* reload character instead

* fix koboldcpp client jiggle arguments

* save scene title

* fix deferred nav

* fix issue where blanking a character detail would bug out

* some layout changes

* character import copies cover image

* remove debug message

* character import via wsm

* deactivate imported characters

* images nav option placeholder

* start move towards new world state templating system

* prompt tweak

* add templates/world-state/*.yaml

* switch to new world state template system in manager

* template editor progress

* more wsm template changes

* template applicator component

* template applicate added to attributes and details

* selective template application

* fix issue with template editing

* attribute and detail templates dont require instructions

* adjust character attributes and details template applicator integration

* add gpt-4o

add gpt-4o-2024-05-13

* autocomplete prompt and postprocessing tweaks

* prompt tweaks

* fix issue where saving a new scene could cause recent config changes to revert

* only download punkt if its not downloaded yet

* working character attribute templates

* character detail generate working
move template generate logic to worldstate.templates

* character creator first steps

* support contextual generate when character doesn't exist

* move talemate wsm templates to their own dir, add supports_spice and supports_style flags

* wsm character creator progress

* character creator progress

* character creator progress and wire up image creation in character editor

* templating progress

* contextual generate generation options

* ux tweaks

* wirte up writing style and spice to generation

* wire spice / writing style to detail generation

* notify when spice is applied

* tweaks to generation spice notifications

* add some help / information to template editor

* fix some issues with detail and attribute generation

* some context gen tweaks

* character gen tweaks

* character color changer

* link to templates form gen option ux

* gen options for dialogue example genrate

* ctrl click to max spice level

* unify spice application notification into a component for reuse

* improvements to example dialogue generation

* some refinements to character editor

* remove some old cruft from scene schema

* wsm scene editor progress

* relock

* relock

* debug message cleanup

* fix issue with tab selection when loading a scene

* scene editor progress

* centralized generation options

* pass generation settings through to character creator

* save changes from wsm view

* scene settings
save copy

* refactor world entry / states editor

* fix issue with applying non-character world state templates

* layout fixes

* allow updating of scene cover image

* move history manager to world editor

* add phi-3 base template

* dialogue cleanup improvements

* refactor scoped game-engine api

* separate legacy creator functions to own file

* remove cruft

* some cleanup and fixes

* add photo style

* remove noisy log message

* better handling of active scene

* some fixes to pin editor

* don't enforce height

* active scene context fixes

* fix intro and scene description generration

* tweak preset for scene direction and summarization tasks

* ensure memory db is open

* update frontend dependencies

* update frontend dependencies

* fix issue with prompt query_memory function returning None

* typo

* default  world state templates

* new scene creation fixes
remove legacy creator ux

* scene export

* fix scene loading from upload

* add claude 3.5 sonnet

* fix automatic client selection when the current client is disabled

* remove cruft

* agent modal extended to support multiple config panels
visual agent prompt prefixes and suffixes addeed

* fix issue with world state template group saving

* resolve attribute name issue `copy`

* RequestInput: fix form validation and keystroke submit

* support chara load from json files also refactor character loading to load.py

* implement simple act-as feature using tab to cycle through active characters in the scene

* docs progress

* tts settings tweaks

* fix issue with loading older talemate scenes

* docs progress

* fix issue with config validation on new installs

* some tweaks for agent setting modals

* default template changed to alpaca

* docs dependencies

* gemma2 template

* nemotron4 template

* docs

* docs

* docs

* change prompt template section to autocomplete

* fix agent config not loading for some agents

* allow deletion of player character

* fix some oddities with scene outline commit

* automatically active player characters and create player characters with the correct actor class

* also set the first npc created as immediately acitve

* add has_active_npcs property and re-emit message history when scene outline is updated.

* indicate when visualizer is busy in the scene tools

* check for busy instead

* prompt tweaks for movie script type dialogue format

* gemma2 prompt fixed

* scene message colors updated

* act as narrator

* move to _old

* scene message appearance tweaks

* fix rubberbanding when editing text field in agent configs

* fix autocompletionm when acting as different character or narrator

* disable autocomplete during command execution

* remove autocomplete button from scene tools

* docs

* relock

* docs

* docs

* improve context pins in dialogue context

* better approximate token count

* fix pin condition editing

* fix issue where scene save as would lose long term memory entries

* immediately clean message history when loading a new scene

* docs

* ensure intro text has formatting markers

* narrator messages written by the player can now be deleted.

* scene editor

* move docs around

* start character editor docs

* more character editor docs:

* fix some ux bugs

* fix template group deletrion not removing the file

* docs

* typos

* docs

* relock

* docs

* notify image generation errors

* linting

* gh pages workflow

* use poetry

* dont use poetry

* link to docs site

* set site_url

* add trailing slash

* fix image paths

* re-add tabbyai link

* fix image generation error triggering incorrectly

* fix intro formatting incosistencies

* remove cruft

* add time passed label to history view

* date adjustments

* tests

* add gpt-4o-mini

* fix links

* remove hard ntlk requirement for voice generation chunking

ntlk error handling

fix typo

* docs

* fix issdue with dupe character card intro text

* disable character forms while templates are being applied.

* failure during context generate no longer locks ux

* refactor client and agent status display in system bar

* llama 3.1 8b claude

* fix format

* adjustments to automcomplete dialogue instructions

* add mistral nemo

* debug info

* fix system agent status getting stuck

* readme

* readme

* fix autocomplete responses when they are framed by quotes
2024-07-26 21:43:06 +03:00

11 KiB

Scene Tools

Tool bar

:material-refresh: Regenerate AI response

This will regenerate the most recent message, if it is an AI generated message.

!!! note "Keyboard modifiers" If you hold ctrl when clicking this button you will be prompted to supply some instructions for the regeneration. This can be useful to guide the AI in a certain direction.

If you hold `ctrl+alt` when clicking this button you will be prompted to supply some instructions for the
regeneration while keeping the original message as context. This is useful for rewrites.

:material-nuke: Regenerate AI Response (nuke option)

This will regenerate the most recent message, if it is an AI generated message, but with a higher temperature and repetition penalties applied, which can lead to more creative responses. Use this to break out of repetitive loops.

!!! note "Keyboard modifiers" If you hold ctrl when clicking this button you will be prompted to supply some instructions for the regeneration. This can be useful to guide the AI in a certain direction.

If you hold `ctrl+alt` when clicking this button you will be prompted to supply some instructions for the
regeneration while keeping the original message as context. This is useful for rewrites.

:material-account-voice: Actor Actions

Will open a context menu that allows you to have the actor perform actions.

Actor Actions

!!! info "Recommendation" Turn auto progress off if you want full control and use these actions to guide the scene.

![auto progress off](/talemate/img/0.26.0/auto-progress-off.png)

:material-bullhorn: Talk with direction - Specific Character

Will prompt you for a direction and then have the actor will generate dialogue and actions based on that direction.

Depending on what the Actor Direction Mode setting in the :material-bullhorn: Director Agent Settings the direction will either be given as an instruction or as inner monologue.

Regardless of mode you should write your instruction so it completets the following sentence: I want you to ...

Some examples:

be angry at the other character

or

be annoyed at the situation and storm off

:material-comment-account-outline: Talk - Specific Character

Will cause the character to generate dialogue and actions based on the current scene state.

:material-comment-text-outline: Talk

Automatically picks a character to generate dialogue and actions based on the current scene state.

:material-script-text: Narrator Actions

Will open a context menu that allows you to have the narrator perform actions.

Narrator Actions

:material-script-text-play: Progress Story

Generates narrative text based on the current scene state, moving the story forward.

:material-script-text-play: Progress Story with Direction

Will prompt you for a direction and then have the narrator generate narrative text based on that direction.

:material-waves: Narrate Environment

A special type of narration that aims to narrate the environment, focusing on visuals, sounds and other sensory information.

:material-crystal-ball: Query

Will prompt you for a question and then have the narrator generate narrative text based on that question.

:material-table-headers-eye: Look at Scene

Will narrate the current state of the scene, without progressing the story.

:material-eye: Look at Character

Will narrate the current state of a character, without progressing the story.

:material-clock: Advance time

Opens a context menu with options to advance time in the scene, ranging from 5 minutes to 10 years.

By default the :material-script-text: Narrator Agent will narrate the time jump, but you can disable this in the :material-script-text: Narrator Agent Settings.

!!! note "Summarization" Whenever time is advanced, the scene state will be updated, and the next message will trigger the Summarization Agent to summarize any events before the time jump.

:material-earth: World State Actions

Automatic State Updates

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"

Please refer to the World State section for more information on how set up custom states to track.

Any favorited state will be shown in the :material-earth: world state context menu. Your list may be different than the one shown here, depending on what you have favorited.

World State Actions

Clicking on any item in Autoamtic State Updates will generate the current state and keep it tracked until it is removed.

A tracked state will have a checkmark next to it.

World State Tracked

:material-book-open-page-variant: Open the world state manager

Will open the world state template editor, where you can view and edit your available world states templates.

:material-refresh: Update the world state

Will cause a regeneration of the world state.

!!! info "Does not run state re-inforcement" Currently, this will not re-inforce the state of the world or characters, it will only update the world state context that is displayed in the left panel under the :material-earth: World section.

:material-puzzle-edit: Creative Actions

Creative Actions

:material-exit-run: Take character out of scene

Take character out of scene

Will remove the character from the scene. This will NOT remove the character from the character list, it will only remove them from the current scene, making the actor no longer partake in the scene.

If the current narration and scene progress has not yet indicated the character has left, you will be prompted for a reason, which will be used to narrate the characters exit. If you provide no reason it will be automatically narrated.

Take character out of scene reason

!!! info "Keyboard modifiers" You can hold the ctrl key when clicking this action to disable the automatic narration altogether.

:material-human-greeting: Call character to scene

Call character to scene

Will add the character back to the scene.

If the current narration and scene progress has not yet indicated the character has entered, you will be prompted for a reason, which will be used to narrate the characters entrance. If you provide no reason it will be automatically narrated.

Call character to scene reason

!!! info "Keyboard modifiers" You can hold the ctrl key when clicking this action to disable the automatic narration altogether.

:material-account-plus: Introduce new character - Directed

Will prompt you for a name and a description of the character, and then generate it and add it to the scene.

Prompt for character name

Prompt for character description

The AI will be prompted to generate a character based on the information you provide. THis may take a moment.

Once it is done, narrative text will be generated to introduce the character.

Character introduction

And the character will now be part of the scene and can be interacted with.

Character added to scene

:material-human-greeting: Introduce new character - From context

If narration or dialogue has been generated that references a character that has not yet been created, you can use this action to introduce them and make them real and interactable.

World State Context

The AI will be prompted to generate a character based on what is known about them in the context.

Once it is done, the character will now be part of the scene and can be interacted with.

Character added to scene

!!! info "Indicator" The availability of this is directly tied to the world state on the left panel.

![World State Context](/talemate/img/0.26.0/scene-tool-creative-introduce-1.png)

The character needs to appear in the list of characters in the world state context. 

![Indicator](/talemate/img/0.26.0/scene-tool-creative-introduce-indicator.png) a little human icon will appear next to the :material-puzzle-edit: `Creative Actions` button if there is a character that can be introduced.

:material-image-frame: Visualizer

!!! info "Availability" If the visualization menu is greyed out, it means that the Visualizer Agent is not enabled or ready.

Please refer to the [Visualizer Agent](/talemate/user-guide/agents/visualizer) section for more information on how to set it up.

:material-image-filter-hdr: Visualize Environment

Will generate a stable diffusion prompt and send it to the visualizer agent to generate an image of the current scene.

The generated image can be viewed by clicking on the :material-image-multiple-outline: New images button on the top right of the screen.

Images ready

!!! note "Early Development" At this early stage of development, all you can do with this generated image is to view it. Future versions will allow you to set it as the background image for the scene.

:material-brush: Visualize Character

Will generate a stable diffusion prompt and send it to the visualizer agent to generate an image of the selected character.

The generated image can be viewed by clicking on the :material-image-multiple-outline: New images button on the top right of the screen.

!!! info This will take longer than the environment visualization, as it will do multiple inquisition prompts to find out more about the character and their current state.

If the character does not have a cover image set the generated image will automatically be set as the cover image.

:material-content-save: Saving

Context menu that will provide you with Save and Save As options.