Difference between revisions of "Rigdio/Future"
(Created page with "'''rigdio''' is an automated soundboard designed to ease the burden on streamers during cup events, and increase the options available to managers. It is available for downloa...") |
|||
Line 11: | Line 11: | ||
rigdio now uses the [https://en.wikipedia.org/wiki/YAML YAML data serialisation language] as the means of handling export instructions. YAML files are much larger than their .4ccm counterparts, but they will allow for much simpler handling of advanced features. | rigdio now uses the [https://en.wikipedia.org/wiki/YAML YAML data serialisation language] as the means of handling export instructions. YAML files are much larger than their .4ccm counterparts, but they will allow for much simpler handling of advanced features. | ||
== No More Reserved Names == | |||
Unlike .4ccm files, YAML files are hierarchical; under the new format, you can have players named "goal" or "anthem" or whatever if you want to. Likewise, there are no reserved characters; however, player names containing :, >, or # will need to be "quoted". | |||
== "Play By Reference" == | == "Play By Reference" == |
Revision as of 20:10, 10 March 2018
rigdio is an automated soundboard designed to ease the burden on streamers during cup events, and increase the options available to managers. It is available for download here on github. This page is designed to help managers prepare for the upcoming v2.0 release of rigdio; for the deprecate v1.x version, see this page. See also the changes from v1.9 section of this page.
This page will be updated as v2.0 grows closer to release.
Audio Exports
rigdio functions by using so-called audio exports. An audio export contains all audio files used by a team in a cup: anthems, goalhorns, chants, and event clips, as well as a YAML file which tells rigdio how to process these songs.
Changes From v1.9
YAML Instruction Files
The .4ccm file format is deprecated. .4ccm was created as a minimalist format for simple lists of songs and conditions; as more features have been added, the limits of the .4ccm structure began to show. While the release version of rigdio v2.0 will still be able to load .4ccm files, they are not guaranteed to function properly on anything introduced after v1.9. Support for the .4ccm format will be ended no later than the 2018 4chan Autumn Babby Cup and possibly as early as the 2018 4chan Spring Babby Cup.
rigdio now uses the YAML data serialisation language as the means of handling export instructions. YAML files are much larger than their .4ccm counterparts, but they will allow for much simpler handling of advanced features.
No More Reserved Names
Unlike .4ccm files, YAML files are hierarchical; under the new format, you can have players named "goal" or "anthem" or whatever if you want to. Likewise, there are no reserved characters; however, player names containing :, >, or # will need to be "quoted".
"Play By Reference"
One of the major limitations of rigdio v1.x was that each instance of an audio file was associated specifically with a given line; even if two players nominally played the same song, it would start from the beginning both times. To remedy this, the shared:
key in the root acts as a registry of files, and can be referred to in other places. As an example, consider the following YAML snippet:
shared: brace: "shared-goalhorn.mp3" goal: Player 1: - filename: p1 hat trick.mp3 goals: [">=",3] - shared: brace goals: ["=",2] Player 2: - filename: p2 hat trick.mp3 goals: [">=",3] - shared: brace goals: ["=",2] default: myteam-gh.mp3
Note how shared
replaces filename
for the brace horn of both players. This tells rigdio that, rather than looking for a file, it should check the files loaded by shared
at the root level. The value of the shared
key tells rigdio what key to look for; in this case, both players are looking for brace
, which will direct them to a single shared instance of shared-goalhorn.mp3
. If Player 1 scores a brace and then Player 2 does, Player 2's brace horn will pick up where Player 1's left off.
New Conditions and Instructions
The switch to YAML format allows for much more advanced metacondition features. Previously, the only metacondition was the not
condition; rigdio v2.0 adds boolean logical conditions (and
and or
, each of which operates on a list of conditions), as well as an if
condition, which can be used to check one condition and use the result of that condition to determine which other conditions to test for a final result. (Note that an and
condition is unnecessary in usual operation, as this is the default behaviour of condition lists. However, inside other metaconditions, and
is necessary to combine multiple conditions into one place.)