Difference between revisions of "FFA/FFABot/Commands"
| Line 32: | Line 32: | ||
====$addboth==== | ====$addboth==== | ||
Syntax: | Syntax: | ||
| − | <pre></pre> | + | <pre>$addboth <ircnick> <alias></pre> |
Example: | Example: | ||
| − | <pre></pre> | + | <pre>$addboth Josh^ Ratchet</pre> |
| − | '''Purpose:''' | + | '''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: | ||
| + | <pre>$addadmin <ircnick> <superiority></pre> | ||
| + | |||
| + | Example: | ||
| + | <pre>$addadmin Jimbob12 true | ||
| + | $addadmin Pink_Tomato false</pre> | ||
| + | |||
| + | '''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==== | ====$removeall==== | ||
Syntax: | Syntax: | ||
| − | <pre></pre> | + | <pre>$removeall</pre> |
Example: | Example: | ||
| − | <pre></pre> | + | <pre>$removeall</pre> |
| − | '''Purpose:''' | + | '''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====Syntax: | ||
| − | <pre></pre> | + | <pre>$removeplayer <alias></pre> |
Example: | Example: | ||
| − | <pre></pre> | + | <pre>$removeplayer Ratchet</pre> |
| − | '''Purpose:''' | + | '''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==== | ====$removecaptain==== | ||
Syntax: | Syntax: | ||
| − | <pre></pre> | + | <pre>$removecaptain <ircnick></pre> |
Example: | Example: | ||
| − | <pre></pre> | + | <pre>$removecaptain Josh^</pre> |
| − | '''Purpose:''' | + | '''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==== | ====$removeadmin==== | ||
Syntax: | Syntax: | ||
| − | <pre></pre> | + | <pre>$removeadmin <ircnick></pre> |
Example: | Example: | ||
| − | <pre></pre> | + | <pre>$removeadmin Josh^</pre> |
| − | '''Purpose:''' | + | '''Purpose:''' If you add an administrator to help |
====$enable==== | ====$enable==== | ||
Revision as of 23:56, 23 August 2014
FFABot Commands
Administrators
$addrange
Syntax:
$addrange <alias1> <alias2> <alias3>
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 <alias>
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 <ircnick> <alias>
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 <ircnick> <alias>
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 <ircnick> <superiority>
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
Example:
$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 <alias>
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 <ircnick>
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 <ircnick>
Example:
$removeadmin Josh^
Purpose: If you add an administrator to help
$enable
Syntax:
Example:
Purpose:
$disable
Syntax:
Example:
Purpose:
$enableall
Syntax:
Example:
Purpose:
$disableall
Syntax:
Example:
Purpose:
$captains
Syntax:
Example:
Purpose:
$players
Syntax:
Example:
Purpose:
$start
Syntax:
Example:
Purpose:
$who
Syntax:
Example:
Purpose:
$help
Syntax:
Example:
Purpose:
Captains
$pick
Syntax:
Example:
Purpose:
$who
Syntax:
Example:
Purpose:
$help
Syntax:
Example:
Purpose:
