The following table has information about every key in config.yml, and the acceptable values for each key.
config Path
| Key | Required | Description | Example Arguments |
|---|
| nick | Yes | The nickname used for the IRC bridge bot. | MutinyBot |
| server | Yes | The server address to connect to. | irc.esper.net |
| port | Yes | The server port to use. | 6667 |
| pass | No | The server pass. Not the same as NickServ password! | foobar |
| message_interval | Yes | The interval in milliseconds between each message sent. | 750 |
| command_prefix | Yes | The command prefix for using commands in IRC. See commands. | ! |
| channels | Yes | The channel(s) to join on connection. | #MutinyDev |
| verbose | Yes | Whether or not IRC messages are relayed to console. | true |
| startup_commands | No | Raw Messages to send to IRC on connection. Great use for auto-identifying to NickServ. | PRIVMSG NickServ :identify MutinyBot supersecretpassword |
irc_to_game Path
| Key | Required | Description | Example Arguments |
|---|
| prefix | Yes | The prefix to use on relaying IRC events to the game. Could be left blank. | &d[IRC]&7 |
| messages.join | Yes | The join message format to use when someone joins the IRC channel. | %user% has joined %channel% |
| messages.part | Yes | The leaving message format to use when someone leaves the IRC channel. | %user% has left %channel% |
| messages.kick | Yes | The kick message format to use when someone is kicked from the IRC channel. | %user% was kicked by %kicker% |
| messages.msg | Yes | The message format to use when someone talks from IRC. | %user%: %msg% |
| messages.nick | Yes | The message format used when someone changes their nickname in IRC. | %oldnick% is now known as %newnick% |
| messages.me | Yes | The message format used when someone sends an ACTION to IRC. | * %user% %action% |
| relay.join | Yes | Whether or not join messages are relayed to the game. | true |
| relay.part | Yes | Whether or not part messages are relayed to the game. | true |
| relay.kick | Yes | Whether or nor kick messages are relayed to the game. | true |
| relay.msg | Yes | Whether or not chat messages are relayed to the game. | true |
| relay.nick | Yes | Whether or not nick messages are relayed to the game. | true |
| relay.me | Yes | Whether or not action messages are relayed to the game. | true |
| relay.color | Yes | if true, MutinyIRC will convert IRC colors to game colors. If false, MutinyIRC will strip IRC colors. | true |
game_to_irc Path
| Key | Required | Description | Example Arguments |
|---|
| prefix | Yes | The prefix to use on relaying game events to IRC. Could be left blank. | <blank> |
| name_format | Yes | The name format used for the variable tag %nf%. | %dname% |
| messages.join | Yes | The join message format to use when someone joins the game. | %dname% has joined. |
| messages.part | Yes | The leaving message format to use when someone leaves the game. | %dname% has left. |
| messages.kick | Yes | The kick message format to use when someone is kicked from the game. | %dname% was kicked (%reason%) |
| messages.msg | Yes | The message format to use when someone talks from game. | <%nf%&r> %msg% |
| messages.me | Yes | The message format used when someone uses the /me or /mchatme command in-game. | * %dname% %action% |
| relay.join | Yes | Whether or not join messages are relayed to IRC. | true |
| relay.part | Yes | Whether or not part messages are relayed to IRC. | true |
| relay.kick | Yes | Whether or nor kick messages are relayed to IRC. | true |
| relay.msg | Yes | Whether or not chat messages are relayed to IRC. | true |
| relay.me | Yes | Whether or not /me or /mchatme messages are relayed to IRC. | true |
| relay.color | Yes | if true, MutinyIRC will convert game colors to IRC colors. If false, MutinyIRC will strip game colors. | true |
advanced Path
| Key | Required | Description | Example Arguments |
|---|
| vault_support | Yes | Whether or not MutinyIRC shall enable Vault Integration. | true |
| factions_support | Yes | Whether or not MutinyIRC shall enable Factions Integration. | true |
| mchat_support | Yes | Whether or not MutinyIRC shall enable MChat Integration. Not necessarily needed if Vault is enabled. | true |
| commands.commands_voice | Yes | The raw message to send when a player with permission sends /voice <user> | MODE %channel% +v %nick% |
| commands.commands_devoice | Yes | The raw message to send when a player with permission sends /devoice <user> | MODE %channel% -v %nick% |
| commands.commands_kick | Yes | The raw message to send when a player with permission sends /kick <user> [reason] | KICK %channel% %nick% :%reason% |
| commands.commands_ban | Yes | The raw message to send when a player with permission sends /ban <user> [reason] | MODE %channel% +b *!*@%host%\r\nKICK %channel% %nick% :%reason% |
