-
Notifications
You must be signed in to change notification settings - Fork 1
Effects
This page describes all the currently available effects, their configuration, presets and showcases examples.
The effects are defined within double curly parentheses {{ }}.
These Tags can be added anywhere in the text, although the location does impact the way in which effects are applied.
The Tag can contain any number of effects separated by comma: {{ t_wave, t_color: red }}.
The whitespaces inside the tags do not matter, the tag itself does not take space within message.
The effects can either be added in three ways:
- By just the name:
{{ m_type }} - By name with preset:
{{ t_color: red }} - By name with configuration:
{{ t_wave: {amp: 0.5, f: 10.0} }}
In general, the message can be understood as a string of letters, being printed one by one by printing head. When this printing head encounters the Tag, it reads the effects within it and starts applying them to next letters. The effects can run once (for ex. pausing the text in place for time) or be applied continuously (like setting the text color, where all the text after tag will be colored).
These effects act up on individual characters, without the context of the message as a whole. They can modify individual letters, their appearance and behavior.
name: template
keyword: t_t
options:
- option1: <value: type>
description: template of the effect help
example: {{ t_t: { option1: 0 } }}
These effects act up on the message as a whole, they make it possible to control how the characters are shown (for example one by one), add dramatic pauses between words, run text-based SFX or in other way interact with the way the characters behave as a group.
These effects act up on the whole RPChat app. They make it possible to change its appearance by adding pictures, changing layout, setting global music or in other way interact with the app on global level.