Message Types
There are a few special message types that you can use in your scenarios:
- 👁 Char. means visible by the character;
- 👁 User means visible by the user (you);
- Reply means that the message triggers a follow-up reply;
- Narrated only applies in scenarios with a narrator, whether the text will be read;
| Template | Command | Description | 👁 Char. | 👁 User | Reply | Narrated |
|---|---|---|---|---|---|---|
{{ char }} |
N/A | A message from the first character in the chat | YES | YES | YES | N/A |
{{ user }} |
your message |
A message from the user | YES | YES | YES | N/A |
{{ scenario_chars.your_role_name }} |
N/A | A message from a character assigned to a scenario or stage role | YES | YES | YES | N/A |
{{ event }} |
/event text |
A narrated event | YES | YES | YES | YES |
{{ story }} |
/story prompt |
A narrated event generated by the story writer | YES | YES | YES | YES |
{{ note }} |
/note text |
A silent note | YES | YES | NO | NO |
{{ secret }} |
/secret text |
A hidden note | YES | NO | NO | NO |
{{ instructions }} |
/instructions text |
Information for the user | NO | YES | NO | NO |
| N/A | /noreply text |
A user message that does not trigger a reply | YES | YES | NO | N/A |
Custom Messages
You can also create fully custom messages using /message, or customMessage using scripting.
The syntax is /message --arg1 "value1" --arg2 --etc -- message.
Arguments:
| Name | Value | Description |
|---|---|---|
| role | Secret, Note, Instructions, Event, User, Assistant |
The type of message |
| character | "character name" |
The name of the character |
| scenario-role | role_name |
The name of the scenario role |
| use-story-writer | boolean |
Use the story writer to generate the message |
| max-new-tokens | number |
The maximum number of new tokens to generate |
| max-sentences | number |
The maximum number of sentences to generate |
| reply | boolean |
The message triggers a follow-up reply |
| narrate | boolean |
The message is narrated |
-- |
string |
The message content (until the end of the block) |
Examples:
Generate a secret message using the story writer:
/message --role Secret --use-story-writer --max-new-tokens 200 --max-sentences 2 -- Then something incredible happens!
Write a message as one of the characters:
/message --character "Catherine" -- Hi! It's me, Catherine!
Write a message as one of the scenario roles:
/message --scenario-role "main" -- I'm this story's main character.
Write a note but disable narration for it
/message --role Note --narrate false -- A loud noise is heard in the distance.