98 lines
14 KiB
HTML
98 lines
14 KiB
HTML
<div data-i18n="System-wide Replacement Macros (in order of evaluation):">
|
||
System-wide Replacement Macros (in order of evaluation):
|
||
</div>
|
||
<ul>
|
||
<li><tt>{{pipe}}</tt> – <span data-i18n="help_macros_1">only for slash command batching. Replaced with the returned result of the previous command.</span></li>
|
||
<li><tt>{{newline}}</tt> – <span data-i18n="help_macros_2">just inserts a newline.</span></li>
|
||
<li><tt>{{trim}}</tt> – <span data-i18n="help_macros_3">trims newlines surrounding this macro.</span></li>
|
||
<li><tt>{{noop}}</tt> – <span data-i18n="help_macros_4">no operation, just an empty string.</span></li>
|
||
<li><tt>{{original}}</tt> – <span data-i18n="help_macros_5">global prompts defined in API settings. Only valid in Advanced Definitions prompt overrides.</span></li>
|
||
<li><tt>{{input}}</tt> – <span data-i18n="help_macros_6">the user input</span></li>
|
||
<li><tt>{{charPrompt}}</tt> – <span data-i18n="help_macros_7">the Character's Main Prompt override</span></li>
|
||
<li><tt>{{charInstruction}}</tt> – <span data-i18n="help_macros_8">the Character's Post-History Instructions override</span></li>
|
||
<li><tt>{{description}}</tt> – <span data-i18n="help_macros_9">the Character's Description</span></li>
|
||
<li><tt>{{personality}}</tt> – <span data-i18n="help_macros_10">the Character's Personality</span></li>
|
||
<li><tt>{{scenario}}</tt> – <span data-i18n="help_macros_11">the Character's Scenario</span></li>
|
||
<li><tt>{{persona}}</tt> – <span data-i18n="help_macros_12">your current Persona Description</span></li>
|
||
<li><tt>{{mesExamples}}</tt> – <span data-i18n="help_macros_13">the Character's Dialogue Examples</span></li>
|
||
<li><tt>{{mesExamplesRaw}}</tt> – <span data-i18n="help_macros_14">unformatted Dialogue Examples </span><b data-i18n="(only for Story String)">(only for Story String)</b></li>
|
||
<li><tt>{{summary}}</tt> – <span data-i18n="help_macros_summary">the latest chat summary generated by the "Summarize" extension (if available).</span></li>
|
||
<li><tt>{{user}}</tt> – <span data-i18n="help_macros_15">your current Persona username</span></li>
|
||
<li><tt>{{char}}</tt> – <span data-i18n="help_macros_16">the Character's name</span></li>
|
||
<li><tt>{{char_version}}</tt> – <span data-i18n="help_macros_17">the Character's version number</span></li>
|
||
<li><tt>{{group}}</tt> – <span data-i18n="help_macros_18">a comma-separated list of group member names or the character name in solo chats. Alias: {{charIfNotGroup}}</span></li>
|
||
<li><tt>{{model}}</tt> – <span data-i18n="help_macros_19">a text generation model name for the currently selected API. </span><b data-i18n="Can be inaccurate!">Can be inaccurate!</b></li>
|
||
<li><tt>{{lastMessage}}</tt> – <span data-i18n="help_macros_20">the text of the latest chat message.</span></li>
|
||
<li><tt>{{lastUserMessage}}</tt> – <span data-i18n="help_macros_lastUser">the text of the latest user chat message.</span></li>
|
||
<li><tt>{{lastCharMessage}}</tt> – <span data-i18n="help_macros_lastChar">the text of the latest character chat message.</span></li>
|
||
<li><tt>{{lastMessageId}}</tt> – <span data-i18n="help_macros_21">index # of the latest chat message. Useful for slash command batching.</span></li>
|
||
<li><tt>{{firstIncludedMessageId}}</tt> – <span data-i18n="help_macros_22">the ID of the first message included in the context. Requires generation to be ran at least once in the current session.</span></li>
|
||
<li><tt>{{currentSwipeId}}</tt> – <span data-i18n="help_macros_23">the 1-based ID of the current swipe in the last chat message. Empty string if the last message is user or prompt-hidden.</span></li>
|
||
<li><tt>{{lastSwipeId}}</tt> – <span data-i18n="help_macros_24">the number of swipes in the last chat message. Empty string if the last message is user or prompt-hidden.</span></li>
|
||
<li><tt>{{reverse:(content)}}</tt> – <span data-i18n="help_macros_reverse">reverses the content of the macro.</span></li>
|
||
<li><tt>{{// (note)}}</tt> – <span data-i18n="help_macros_25">you can leave a note here, and the macro will be replaced with blank content. Not visible for the AI.</span></li>
|
||
<li><tt>{{time}}</tt> – <span data-i18n="help_macros_26">the current time</span></li>
|
||
<li><tt>{{date}}</tt> – <span data-i18n="help_macros_27">the current date</span></li>
|
||
<li><tt>{{weekday}}</tt> – <span data-i18n="help_macros_28">the current weekday</span></li>
|
||
<li><tt>{{isotime}}</tt> – <span data-i18n="help_macros_29">the current ISO time (24-hour clock)</span></li>
|
||
<li><tt>{{isodate}}</tt> – <span data-i18n="help_macros_30">the current ISO date (YYYY-MM-DD)</span></li>
|
||
<li><tt>{{datetimeformat …}}</tt> – <span data-i18n="help_macros_31">the current date/time in the specified format, e. g. for German date/time: </span><tt>{{datetimeformat DD.MM.YYYY HH:mm}}</tt></li>
|
||
<li><tt>{{time_UTC±#}}</tt> – <span data-i18n="help_macros_32">the current time in the specified UTC time zone offset, e.g. UTC-4 or UTC+2</span></li>
|
||
<li><tt>{{timeDiff::(time1)::(time2)}}</tt> – <span data-i18n="help_macros_33">the time difference between time1 and time2. Accepts time and date macros. (Ex: {{timeDiff::{{isodate}} {{time}}::2024/5/11 12:30:00}})</span></li>
|
||
<li><tt>{{idle_duration}}</tt> – <span data-i18n="help_macros_34">the time since the last user message was sent</span></li>
|
||
<li><tt>{{bias "text here"}}</tt> – <span data-i18n="help_macros_35">sets a behavioral bias for the AI until the next user input. Quotes around the text are important.</span></li>
|
||
<li><tt>{{roll:(formula)}}</tt> – <span data-i18n="help_macros_36">rolls a dice. (ex: </span><tt>{{roll:1d6}}</tt><span data-i18n="space_ will roll a 6-sided dice and return a number between 1 and 6)"> will roll a 6-sided dice and return a number between 1 and 6)</span></li>
|
||
<li><tt>{{random:(args)}}</tt> – <span data-i18n="help_macros_37">returns a random item from the list. (ex: </span><tt>{{random:1,2,3,4}}</tt><span data-i18n="space_ will return 1 of the 4 numbers at random. Works with text lists too."> will return 1 of the 4 numbers at random. Works with text lists too.</span></li>
|
||
<li><tt>{{random::(arg1)::(arg2)}}</tt> – <span data-i18n="help_macros_38">alternative syntax for random that allows to use commas in the list items.</span></li>
|
||
<li><tt>{{pick::(args)}}</tt> – <span data-i18n="help_macros_39">picks a random item from the list. Works the same as {{random}}, with the same possible syntax options, but the pick will stay consistent for this chat once picked and won't be re-rolled on consecutive messages and prompt processing.</span></li>
|
||
<li><tt>{{banned "text here"}}</tt> – <span data-i18n="help_macros_40">dynamically add text in the quotes to banned words sequences, if Text Generation WebUI backend used. Do nothing for others backends. Can be used anywhere (Character description, WI, AN, etc.) Quotes around the text are important.</span></li>
|
||
</ul>
|
||
<div data-i18n="Instruct Mode and Context Template Macros:">
|
||
Instruct Mode and Context Template Macros:
|
||
</div>
|
||
<div>
|
||
<small data-i18n="(enabled in the Advanced Formatting settings)">(enabled in the Advanced Formatting settings)</small>
|
||
</div>
|
||
<ul>
|
||
<li><tt>{{maxPrompt}}</tt> – <span data-i18n="help_macros_41">max allowed prompt length in tokens = (context size - response length)</span></li>
|
||
<li><tt>{{exampleSeparator}}</tt> – <span data-i18n="help_macros_42">context template example dialogues separator</span></li>
|
||
<li><tt>{{chatStart}}</tt> – <span data-i18n="help_macros_43">context template chat start line</span></li>
|
||
<li><tt>{{systemPrompt}}</tt> – <span data-i18n="help_macros_44">system prompt content if enabled (either character prompt override if allowed, or defaultSystemPrompt)</span></li>
|
||
<li><tt>{{defaultSystemPrompt}}</tt> – <span data-i18n="help_macros_45">system prompt content</span></li>
|
||
<li><tt>{{instructSystemPromptPrefix}}</tt> – <span data-i18n="help_macros_46">instruct system prompt prefix sequence</span></li>
|
||
<li><tt>{{instructSystemPromptSuffix}}</tt> – <span data-i18n="help_macros_47">instruct system prompt suffix sequence</span></li>
|
||
<li><tt>{{instructUserPrefix}}</tt> – <span data-i18n="help_macros_48">instruct user prefix sequence</span></li>
|
||
<li><tt>{{instructUserSuffix}}</tt> – <span data-i18n="help_macros_49">instruct user suffix sequence</span></li>
|
||
<li><tt>{{instructAssistantPrefix}}</tt> – <span data-i18n="help_macros_50">instruct assistant prefix sequence</span></li>
|
||
<li><tt>{{instructAssistantSuffix}}</tt> – <span data-i18n="help_macros_51">instruct assistant suffix sequence</span></li>
|
||
<li><tt>{{instructFirstAssistantPrefix}}</tt> – <span data-i18n="help_macros_52">instruct assistant first output sequence</span></li>
|
||
<li><tt>{{instructLastAssistantPrefix}}</tt> – <span data-i18n="help_macros_53">instruct assistant last output sequence</span></li>
|
||
<li><tt>{{instructSystemPrefix}}</tt> – <span data-i18n="help_macros_54">instruct system message prefix sequence</span></li>
|
||
<li><tt>{{instructSystemSuffix}}</tt> – <span data-i18n="help_macros_55">instruct system message suffix sequence</span></li>
|
||
<li><tt>{{instructSystemInstructionPrefix}}</tt> – <span data-i18n="help_macros_56">instruct system instruction prefix</span></li>
|
||
<li><tt>{{instructUserFiller}}</tt> – <span data-i18n="help_macros_57">instruct first user message filler</span></li>
|
||
<li><tt>{{instructStop}}</tt> – <span data-i18n="help_macros_58">instruct stop sequence</span></li>
|
||
<li><tt>{{instructFirstUserPrefix}}</tt> – <span data-i18n="help_macros_first_user">instruct user first input sequence</span></li>
|
||
<li><tt>{{instructLastUserPrefix}}</tt> – <span data-i18n="help_macros_last_user">instruct user last input sequence</span></li>
|
||
</ul>
|
||
<div data-i18n="Chat variables Macros:">
|
||
Chat variables Macros:
|
||
</div>
|
||
<div><small data-i18n="Local variables = unique to the current chat">Local variables = unique to the current chat</small></div>
|
||
<div><small data-i18n="Global variables = works in any chat for any character">Global variables = works in any chat for any character</small></div>
|
||
<div><small data-i18n="Scoped variables = works in STscript">Scoped variables = works in STscript</small></div>
|
||
<ul>
|
||
<li><tt>{{getvar::name}}</tt> – <span data-i18n="help_macros_59">replaced with the value of the local variable "name"</span></li>
|
||
<li><tt>{{setvar::name::value}}</tt> – <span data-i18n="help_macros_60">replaced with empty string, sets the local variable "name" to "value"</span></li>
|
||
<li><tt>{{addvar::name::increment}}</tt> – <span data-i18n="help_macros_61">replaced with empty strings, adds a numeric value of "increment" to the local variable "name"</span></li>
|
||
<li><tt>{{incvar::name}}</tt> – <span data-i18n="help_macros_62">replaced with the result of the increment of value of the variable "name" by 1</span></li>
|
||
<li><tt>{{decvar::name}}</tt> – <span data-i18n="help_macros_63">replaced with the result of the decrement of value of the variable "name" by 1</span></li>
|
||
<li><tt>{{getglobalvar::name}}</tt> – <span data-i18n="help_macros_64">replaced with the value of the global variable "name"</span></li>
|
||
<li><tt>{{setglobalvar::name::value}}</tt> – <span data-i18n="help_macros_65">replaced with empty string, sets the global variable "name" to "value"</span></li>
|
||
<li><tt>{{addglobalvar::name::value}}</tt> – <span data-i18n="help_macros_66">replaced with empty string, adds a numeric value of "increment" to the global variable "name"</span></li>
|
||
<li><tt>{{incglobalvar::name}}</tt> – <span data-i18n="help_macros_67">replaced with the result of the increment of value of the global variable "name" by 1</span></li>
|
||
<li><tt>{{decglobalvar::name}}</tt> – <span data-i18n="help_macros_68">replaced with the result of the decrement of value of the global variable "name" by 1</span></li>
|
||
<li><tt>{{var::name}}</tt> – <span data-i18n="help_macros_69">replaced with the value of the scoped variable "name"</span></li>
|
||
<li><tt>{{var::name::index}}</tt> – <span data-i18n="help_macros_70">replaced with the value of item at index (for arrays / lists or objects / dictionaries) of the scoped variable "name"</span></li>
|
||
</ul>
|