text
stringlengths 0
1.13k
|
---|
1 = The song can only play once within a trigger until the trigger gets changed, but resets when there are no more |
songs to play |
2 = The song can only play once within a trigger until the trigger gets changed. Does not get reset if there are no |
more songs to play |
3 = The song can only play once for every time you are logged into a world |
4 = The song can only play once per world |
5 = The song can only play once per game session |
play_x: Determines the number of time the song has to be played before play_once can take effect |
(Accepts any positive integer) |
resume_on_play: Determines if the song will resume playing from the last known time when it is played more than |
once per session |
(Accepts true/false) |
volume: The value here represents the volume percentage of the song after the category is taken into account, where |
1 is 100%. Note that up to 10x the normal maximum volume is supported but that does not mean it is a good idea to |
set it to that |
(Accepts any decimal value between 0 and 10) |
Loop Points |
Songs can also have loop points defined for them in addition to the rest of the parameters. For each loop, you need a [loop] table under the song. While they are called "loops" they can be used for more than just going back to a certain point in the song. The accepted loop parameters are from, to, and num_loops: |
from: The time in milliseconds that the song must reach for the loop to run |
(Accepts any positive integer) |
to: The time in milliseconds that the song will be set to after then loop is run. |
Note that this can be greater that the "from" value to skip parts of a song |
(Accepts any positive integer) |
num_loops: The number of times the loop will run before allowing the song to continue |
(Accepts any positive integer) |
Universal Parameters |
Index |
Both triggers and songs are able to have universal parameters which are fallback parameters that are drawn from when the respective parameters are not set. Universal parameters can be overwritten for specific triggers and songs by defining a non default value for the associated parameter for that trigger or song. Each universal parameter set will go under a [universal] table under either the [triggers] table or the [songs] table. |
Universal Trigger Parameters |
The accepted universal trigger parameters are fade_in, fade_out, persistence, song_delay, start_delay, stop_delay, and trigger_delay. |
Universal Triggers Example |
[triggers] |
[triggers.universal] |
fade_in = 50 |
fade_out = 50 |
persistence = 100 |
Universal Song Parameters |
The accepted universal song parameters are volume, pitch, play_once, and must_finish. |
Note that you cannot have a song titled universal, since that would conflict with the universal parameters. |
Universal Songs Example |
[songs] |
[songs.universal] |
volume = 0.75 |
play_once = 1 |
Transitions |
Index |
The transitions file allows you to attach title cards and image cards to certain trigger configurations so that when the required triggers are all active, some text or an image is rendered to the screen. |
Title Cards |
Index |
All title cards go under a [title] table. The accepted title card parameters are triggers, titles, subtitles, title_color, subtitle_color, play_once, vague, centered, horizontal_alignment, vertical_alignment, x, y, scale_x, scale_y, and subtitle_scale. Here are what those do: |
triggers: A list of triggers that needs to be active for the title card to run. Remember to format |
the triggers as how they are seen in the debug info for this to work correctly. |
titles: A list of potential titles, where if there is more than a single element one of them will be |
randomly selected. |
subtitles: A list of potential subtitles, where if there is more than a single element one of them will be |
randomly selected. |
title_color: The text color of the rendered title. |
subtitle_color: The text color of the rendered subtitle. |
play_once: Determines whether the title card can play once or more than once. Unlike the song parameter, |
this one is a simple true/false. |
vague: If this is true, the set triggers need to be playable, but not necessarily active. |
centered: Determines whether the text is centralized or left aligned at the set position. |
horizontal_alignment: Determines the default horizontal alignment of the text before the x parameter is applied. |
Accepts "left", "center", or "right". |
vertical_alignment: Determines the default vertical alignment of the text before the y parameter is applied. |
Accepts "top", "center", or "bottom". |
x: The horizontal position offset of the text, where positive values move it to the right and negative values |
move it to the left. |
y: The vertical position offset of the text, where positive values move it down and negative values move it up. |
scale_x: The horizontal scaling of the text, where the default is 1 (100%) |