Skip to content
This repository was archived by the owner on Oct 27, 2020. It is now read-only.

Command Reference

Cameron "Clapton edited this page Sep 8, 2016 · 15 revisions

Disclaimer: This page is a work in progress, and will be fully filled out within the next few days.

Rat Board

Command Description
`!active <Client Name Case #>`
`!assign <Client Name Case #> [rat2] [rat3]`
`!clear <Client Name Case #> [First Limpet Sender]`
!closed Lists the last 5 closed rescues, and their corresponding database IDs.
`!cmdr <Client Name Case #> `
`!codered <Client Name Case #>`
`!delete <Rescue ID List>`
`!epic <Client Name Case #>`
!flush Resets cached RatNames. Helps with bugged rag names on !assign
!grab <Client Name> Grabs the last message the client sent, and adds it to their case.
!host Shows you your current host to verify priviliges.
`!inject <Client Name Case #> `
!list [-iru@] List the currently active, open cases.
Parameters:
i: lists inactive cases.
r: Show assigned rats.
u: Show only cases with no assigned rats.
@: show case ids.
`!md <Client Name Case #> `
!mdlist Shows the Marked for Deletion List™. (For cool people only)
!mdremove <Rescue ID> Removes a case from the Marked for Deletion List™ (Does NOT reopen the case!)
`!pc <Client Name Case #>`
`!pwl <Client Name Case #>`
`!quote <Client Name Case #>`
!quoteid <Rescue ID> Recites all known information for the specified rescue ID.
!ratid <ratname> Gets a rats' ID from the API.
!refreshboard Forcefully resets the board, and grabs fresh information from the API.
WARNING: Use with care, usage resets board numbers.
!reopen <Rescue ID> Reopens a case.
`!sub <Client Name Case #> [Replacement Text]`
`!sys <Client Name Case #> `
`!title <Client Name Case #> <Title to set>`
`!unassign <Client Name Case #> [rat2] [rat3]`
!version Shows the bot's current version and uptime.
`!xb <Client Name Case #>`

##!active

Toggles the active status of a case.

Usage: !active <Client Name|Case #>
Permission: Rat
Aliases: !activate !inactive !deactivate
Example: !active 2 !active AClient

##!assign

Assigns rats to a client's case.

Usage: !assign <Client Name|Case #> <Rat1> [rat2] [rat3]
Permission: Rat
Aliases: !add !go
Example:

##!clear

Marks a case as closed, and adds the first limpet sender to the case if specified.

Usage: !clear <Client Name|Case #> [First Limpet Sender]
Permission: Rat
Aliases: !close
Example:

##!closed

Lists the last 5 closed rescues, and their corresponding database IDs.

Usage: !closed
Permission: Rat
Aliases: !recent
Example:

##!cmdr

Sets a client's in-game CMDR name.

Usage: !cmdr <Client Name|Case #> <CMDR name>
Permission: Rat
Aliases: !commander
Example:

##!codered

Toggles the code red status of a case.

Usage: !codered <Client Name|Case #>
Permission: Rat
Aliases: !casered !cr
Example:

##!delete

Deletes a rescue, or lists rescues up for deletion.

Usage: !delete <Rescue ID|List>
Permission: Overseer
Aliases:
Example:

##!epic

Toggles the Epic status of a case.

Usage: !epic <Client Name|Case #>
Permission: Rat
Aliases:
Example:

##!flush

Resets cached RatNames. Helps with bugged rag names on !assign

Usage: !flush
Permission: Rat
Aliases: !resetnames !rn !flushnames !fn
Example:

##!grab

Grabs the last message the client sent, and adds it to their case.

Usage: !grab <Client Name>
Permission: Rat
Aliases:
Example:

##!host

Shows you your current host to verify priviliges.

Usage: !host
Permission: None
Aliases:
Example:

##!inject

Injects a custom line of text into the client's case. If no case is found, a new case is opened.

Usage: !inject <Client Name|Case #> <Text to Add>
Permission: Rat
Aliases:
Example:

##!list

List the currently active, open cases.
Parameters:
i: lists inactive cases.
r: Show assigned rats.
u: Show only cases with no assigned rats.
@: show case ids.

Usage: !list [-iru@]
Permission: Rat
Aliases:
Example:

##!md

Marks a case as closed, and adds it to the Marked for Deletion List™.

Usage: !md <Client Name|Case #> <Reason for Deletion>
Permission: Rat
Aliases: !mdadd
Example:

##!mdlist

Shows the Marked for Deletion List™. (For cool people only)

Usage: !mdlist
Permission: Overseer
Aliases:
Example:

##!mdremove

Removes a case from the Marked for Deletion List™ (Does NOT reopen the case!)

Usage: !mdremove <Rescue ID>
Permission: Overseer
Aliases: !mdremove !mdr !mdd !mddeny
Example:

##!pc

Sets a case's platform to PC.

Usage: !pc <Client Name|Case #>
Permission: Rat
Aliases:
Example:

##!pwl

Creates and shortens the link for the paperwork of a case.

Usage: !pwl <Client Name|Case #>
Permission: Rat
Aliases: !pwlink !paperwork !paperworklink
Example:

##!quote

Recites all known information for the specified open case.

Usage: !quote <Client Name|Case #>
Permission: Rat
Aliases:
Example:

##!quoteid

Recites all known information for the specified rescue ID.

Usage: !quoteid <Rescue ID>
Permission: Rat
Aliases:
Example:

##!ratid

Gets a rats' ID from the API.

Usage: !ratid <ratname>
Permission: Rat
Aliases: !id
Example:

##!refreshboard

Forcefully resets the board, and grabs fresh information from the API.
WARNING: Use with care, usage resets board numbers.

Usage: !refreshboard
Permission: Overseer
Aliases: !resetboard !forceresetboard !forcerefreshboard !frb !fbr !boardrefresh
Example:

##!reopen

Reopens a case.

Usage: !reopen <Rescue ID>
Permission: Overseer
Aliases:
Example:

##!sub

Substitute or delete an existing line of text to the client's case.
DOES NOT perform autocorrection/autodetection

Usage: !sub <Client Name|Case #> <Line Number> [Replacement Text]
Permission: Rat
Aliases:
Example:

##!sys

Sets a case's system.

Usage: !sys <Client Name|Case #> <System Name>
Permission: Rat
Aliases: !system !loc !location
Example:

##!title

Sets the Operation title of a rescue.

Usage: !title <Client Name|Case #> <Title to set>
Permission: Rat
Aliases:
Example:

##!unassign

Removes rats from a client's case.

Usage: !unassign <Client Name|Case #> <Rat1> [rat2] [rat3]
Permission: Rat
Aliases: !deassign !rm !remove !standdown
Example:

##!version

Shows the bot's current version and uptime.

Usage: !version
Permission: None
Aliases: !uptime
Example:

##!xb

Sets a case's platform to Xbox.

Usage: !xb <Client Name|Case #>
Permission: Rat
Aliases: (don't worry about it)
Example:

for reference ##!CmdSectionTemplate

DESCRIPTION

Usage: !CmdSectionTemplate <param> [oparam]
Permission: PERMISSION
Aliases: !alias !alias2
Example: !cmdsectiontemplate exampleParam exampleOptionalParam

Clone this wiki locally