FFA/FFABot/Commands

$addrange
Syntax: $addrange

Example: $addrange Ratchet Blue_Flame ObnoxiousPenguin James123 Player_1 APerson

Purpose: To add many players from the wiki in one command. As opposed to using "$addplayer Player_1", "$addplayer Blue_Flame", and so forth. It is recommended that you don't add more than 25 players at a time (mostly to keep it clean and to ensure the bot catches them all. If you post too many IRC may split your message and not catch all of the names). Also, ensure that you separate players by spaces (NOT by commas and spaces as such: Ratchet, Blah, Player_1). AND, make sure that you don't use the space in "Player 1"'s name. Use "Player_1" instead. Spaces should be denoted by underscores.

$addplayer
Syntax: $addplayer

Example: $addplayer Tom_the_Cat

Purpose: To add players to the list individually. The initial adding of players should use "$addrange" due to the fact that 48 players must be added to the list. But, if a mistake is made and a name gets inputted incorrectly, this command could be used to add the single player to the list that was missed.

$addcaptain
Syntax: $addcaptain

Example: $addcaptain Josh^ Ratchet

Purpose: After a player has been added via the "$addrange" or "$addplayer" command, they may be added as a captain. You use this command to link the already added player's tron alias to their IRC nick. This takes that player out of the selection pool when teams are being chosen (seeing how you can't exactly pick a captain to be on your team).

$addboth
Syntax: $addboth

Example: $addboth Josh^ Ratchet

Purpose: Similar syntax to $addcaptain, this command is useful when the captain isn't already added as a player via "$addrange" or "$addplayer". Perhaps unneccessary, but can be useful if someone is too lazy to do $addplayer and then $addcaptain. It's sortof a merge of the two. Adding functionality just for the sake of those who want features rather than extra work.

$addadmin
Syntax: $addadmin

Example: $addadmin Jimbob12 true $addadmin Pink_Tomato false

Purpose:If you are having trouble using the IRC bot, you can add another administrator to help you out. By giving them a superiority tag, you are enabling them to do absolutely anything with the bot. By giving them a "false" superiority value, you are giving yourself a slight bit more security with the bot and have less of a risk of having to restart the bot if something gets screwed up. Be mindful. Don't add an administrator unless you absolutely need to.

$removeall
Syntax: $removeall

Purpose: In the case that you have severely screwed up the adding of players/captains/whatever, use this command to refresh all lists. It will remove everyone from all lists except the superior administrator from the administrator list.

$removeplayer
Syntax: $removeplayer

Example: $removeplayer Ratchet

Purpose:To remove a player that you may have accidentally added to the list. If that player is also added as a captain, it will detect that and remove the player from the players list and the captains list.

$removecaptain
Syntax: $removecaptain

Example: $removecaptain Josh^

Purpose: In case you accidentally add the wrong IRC nick, or a captain backs out and decides that he/she cannot be captain. This command can be used to unlink a player's alias from a captain's IRC nick. Will only remove from the captains list, not the players list.

$removeadmin
Syntax: $removeadmin

Example: $removeadmin Josh^

Purpose: If you add an administrator to help you run the IRC bot, I strongly recommend removing the administrator status as soon as things get figured out. It reduces the likelihood of things getting screwed up because you are maintaining complete control over the bot.

$enable
Syntax: $enable

Example: $enable Jimbob12

Purpose: For a captain to be able to "pick" a player when it is his/her turn, they must be "enabled". By default, when the "$start" command is executed, all captains are automatically enabled. But, if you wish to "pause" the picking process, or if a captain "lags out" of IRC, you may want to disable a particular captain's IRC nick. $enable gives them the ability to pick again. $disable removes that ability.

$disable
Syntax: $disable

Example: $disable Jimbob12

Purpose: For a captain to be able to "pick" a player when it is his/her turn, they must be "enabled". By default, when the "$start" command is executed, all captains are automatically enabled. But, if you wish to "pause" the picking process, or if a captain "lags out" of IRC, you may want to disable a particular captain's IRC nick. $enable gives them the ability to pick again. $disable removes that ability.

$enableall
Syntax: $enableall

Purpose: This is done by default when the $start command is initiated. But, in the event that you need to re-enable all captains (or you want to ensure that they are all enabled), this command exists.

$disableall
Syntax: $disableall

Purpose: When the $start command is used, the picking process begins. All captains are "enabled", which gives them the ability to add players to their team. If you wish to "pause" the picking process and make all captains unable to choose, perhaps to make an announcement, this command is useful for that. It prevents any more picks from being made, at least until the captain(s) are enabled again.

$captains
Syntax: $captains

Purpose: To display a list of captains. "Enabled" captains will be green, and "disabled" captains will be displayed as red.

$players
Syntax: $players

Purpose: To display a list of players currently added to the players list. If the picking has been initialized, then $players will show an updated list of non-captain and non-chosen players.

$start
Syntax: $start

Purpose: This initiates the picking process. First, the bot will ensure that the correct number of captains and players have been signed up. Next, the bot will randomly assign each captain a number between 1 and 8, determining the picking order. Then, the picking order is printed to the screen. The bot will automatically determine which IRC user holds the next pick, and will prompt them each time to submit their pick. Once all players have been chosen by captains, a comprehensive final list of the teams will be printed in the channel. After the $start command is issued, very little participation will be required from administrators, if any.

$who
Syntax: $who

Purpose: Messages the user a list of all Administrators, Captains, and Players.

$help
Syntax: $help

Purpose: Links the user to the documentation page www.wiki.armagetronad.net/index.php/FFABot

$pick
Syntax: $pick

Example: $pick Ratchet

Purpose: When the start command is initiated, each captain is "enabled". This allows each captain to utilize the $pick function to choose their players. The IRC bot will determine which captain's turn it is to pick, and it will prompt them for their player choice. The captain then uses the $pick command to pick their player. Assuming the player exists and wasn't already chosen, that player will be added to the captain's team. After this is performed, there is no redacting your pick.

$who
Syntax: $who

Purpose: Messages the user a list of all Administrators, Captains, and Players.

$help
Syntax: $help

Purpose: Links the user to the documentation page www.wiki.armagetronad.net/index.php/FFABot