Custom Character Properties - altoiddealer/ad_discordbot GitHub Wiki

Character files can include a variety of additional parameters to avoid having to fiddle with settings and options when changing from one character to the next.

  • These options are updated / take effect when the bot is loaded, and when using /character command

  • Including these options will overwrite current / default settings

  • Omitting ANY of these options will not cause settings to disappear or break


Using Voice Channel | Behavior | State | Extensions | Tags


Custom Character Properties

Optional Parameter value type description default
use_voice_channel True/False Whether the character can join VC False
behavior {dict} Definitions for general behaviors of the bot See below
state {dict} Definitions for text-generation-webui parameters See base_settings.yaml
extensions {dict} Not just limited to TTS - any extensions defined here will be toggled by the character None
Tags {dict} Robust and versatile system to customize the character's behavior see dict_tags.yaml

Using Voice Channel

See Installation for requirements.

Just add use_voice_channel: True, along with the TTS extension info, to any character you want to speak their responses.


Behavior

Your characters may include a Behaviors key which will override default behavior settings.

See more here: Custom Behaviors


State

There's really too many parameters to list here. Refer to dict_base_settings.yaml as well as text-generation-webui


Extensions

Character specific extension params will be applied on startup and character change. These will override any default extension settings defined natively (in '/text-generation-webui/settings.yaml') Must be defined using exact name of extension (in '../extensions/'). ** Check the extension's 'script.py' for valid params. **

Example formatting:

extensions:
  alltalk_tts:
    activate: True            # controls if alltalk_tts runs or not.
    voice: female_01.wav      # name of a file in text-generation-webui/extensions/alltalk_tts/voices/  (Should be 6-8sec .wav file)
    language: English         # valid options: Arabic, Chinese, Czech, Dutch, English, French, German, Hungarian, Italian, Japanese, Korean, Polish, Portuguese, Russian, Spanish, Turkish
    narrator_enabled: false
    narrator_voice: female_01.wav
    local_temperature: 0.7
    local_repetition_penalty: 10.0
    remove_trailing_dots: false
    show_text: false
  coqui_tts:
    activate: false
    voice: female_01.wav
    language: English

Tags

Characters can have their own defined 'Tags'

Refer to the Tags Wiki Page