Difference between revisions of "Rigdio"

From Rigged Wiki
Jump to navigation Jump to search
(Created page; expect more resources shortly after I bring rigDJ back up to speed with current conditions.)
 
Line 40: Line 40:
** Lines starting with <code>victory;</code> denote victory anthems. If no victory anthem is provided, information from the <code>anthem;</code> lines will be duplicated for victory anthems.
** Lines starting with <code>victory;</code> denote victory anthems. If no victory anthem is provided, information from the <code>anthem;</code> lines will be duplicated for victory anthems.
** Lines starting with <code>goal;</code> denote default goalhorns (those not associated with any particular player).
** Lines starting with <code>goal;</code> denote default goalhorns (those not associated with any particular player).
** All other lines start with names of players, and will assign their goalhorns to a button for that specific player.
* If multiple players share a goalhorn, separate their names with commas. (Because of this, player names cannot contain commas.)
* If multiple players share a goalhorn, separate their names with commas. (Because of this, player names cannot contain commas.)



Revision as of 17:38, 26 June 2017

rigdio is an automated goalhorn/anthem player 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.

Contents of a Music Export

A music export for rigdio is a folder containing all of the songs, as well as a .4ccm file which tells rigdio how to use them. Music files can be any format playable by VLC.

There are two main ways to build a .4ccm file, each outlined below.

Building .4ccm Files with rigDJ

rigDJ is the GUI editor for .4ccm files, released along with rigdio. It allows graphical editing of player songs and conditions; if you intend to use more complex instructions, it is recommended you use rigDJ to avoid needing to know the .4ccm formatting for every condition type.

This section will be expanded once rigdio 1.5 is released, bringing rigDJ up to current rigdio specs.

Editing Raw .4ccm Files

.4ccm files are just plain text files with an alternate extension, and can be edited with your text editor of choice.

As an example, the following represents O icon.png /o/ from the 2017 4chan Spring Babby Cup:

name;o
# default anthem
anthem;O - 1 - Anthem.mp3
# victory anthem
victory;O - 2 - Victory Anthem.mp3

# default goalhorn
goal;O - 3 - Main goalhorn.mp3

# player goalhorns
Takumi;O - 4 - Takumi single goalhorn.mp3;goals = 1
Takumi;O - 5 - Takumi brace+ goalhorn.mp3;goals >= 2
Twingo;O - 6 - Twingo goalhorn.mp3;goals = 1
Miata;O - 7 - Miata goalhorn.mp3
Scotty Kilmer;O - 8 - Scotty Kilmer goalhorn.mp3
[COOL VIBRATIONS];O - 9 - [COOL VIBRATIONS] goalhorn.mp3

File Layout

The file is laid out like so:

  • Empty lines and lines starting with a # are ignored.
  • The name;TEAMNAME line tells rigdio what team this file is for. If present, it must be the first line in the file; if the first lime does not provide a name, the file name will be used instead.
  • Other than the name; line, all other lines are of the form NAME;SONGFILE;CONDITIONS. There are three "special" names, which cannot be used for players:
    • Lines starting with anthem; denote anthems. Per cup rules, at least one anthem is required.
    • Lines starting with victory; denote victory anthems. If no victory anthem is provided, information from the anthem; lines will be duplicated for victory anthems.
    • Lines starting with goal; denote default goalhorns (those not associated with any particular player).
    • All other lines start with names of players, and will assign their goalhorns to a button for that specific player.
  • If multiple players share a goalhorn, separate their names with commas. (Because of this, player names cannot contain commas.)

Detailed Breakdown

Returning to the O icon.png /o/ example:

  • name;o tells us this is the export for O icon.png /o/.
  • anthem;O - 1 - Anthem.mp3 tells us that we should play O - 1 - Anthem.mp3 as an anthem.
  • victory;O - 2 - Victory Anthem.mp3 tells us that we should play O - 2 - Victory Anthem.mp3 as a victory anthem.
  • goal;O - 3 - Main goalhorn.mp3 tells us that we should play O - 3 - Main goalhorn.mp3 as a standard goalhorn.
  • The next two lines both assign goalhorns to the player Takumi, and use the goals condition to determine which one plays:
    • Takumi;O - 4 - Takumi single goalhorn.mp3;goals = 1 says that when Takumi has exactly one goal (i.e., his first goal of the match), play O - 4 - Takumi single goalhorn.mp3.
    • Takumi;O - 5 - Takumi brace+ goalhorn.mp3;goals >= 2 says that when Takumi has two or more goals, play O - 5 - Takumi brace+ goalhorn.mp3.
  • Twingo;O - 6 - Twingo goalhorn.mp3;goals = 1 also uses the goals condition. Twingo's goalhorn will play for its first goal of the match. When this condition is not met, it will default to the regular goalhorn.
  • Miata;O - 7 - Miata goalhorn.mp3 will always play O - 7 - Miata goalhorn.mp3 when Miata scores.
  • Scotty Kilmer;O - 8 - Scotty Kilmer goalhorn.mp3 will always play O - 8 - Scotty Kilmer goalhorn.mp3 when Scotty Kilmer scores.
  • [COOL VIBRATIONS];O - 9 - [COOL VIBRATIONS] goalhorn.mp3 will always play O - 9 - [COOL VIBRATIONS] goalhorn.mp3 when [COOL VIBRATIONS] scores.

Quick Export Filename Conventions

rigdio also supports "quick export" conventions, designed to make preparing an export without conditions simple. Consider the following (Gsg icon.png /gsg/ from /vg/ League 8):

name;gsg
anthem
victory;gsg - Anthem.mp3
goal
Kojak
Mosley
Syndicalism

The lack of song names on lines tells the program to look for a specific filename:

  • TEAMNAME - Anthem.mp3 for anthems.
  • TEAMNAME - Victory Anthem.mp3 for victory anthems.
  • TEAMNAME - Goalhorn.mp3 for goalhorns.
  • TEAMNAME - PLAYERNAME Goalhorn.mp3 for anything other than a reserved name.

The Gsg icon.png /gsg/ file is thus equivalent to.

name;gsg
anthem;gsg - Anthem.mp3
victory;gsg - Anthem.mp3
goal;gsg - Goalhorn.mp3
Kojak;gsg - Kojak Goalhorn.mp3
Mosley;gsg - Mosley Goalhorn.mp3
Syndicalism;gsg - Syndicalism Goalhorn.mp3

Note that quick exports can only be used on lines which have no conditions.