MechaSqueak is a IRC chat bot for the FuelRats IRC server. It's major function is to provide integration between the IRC server and the FuelRats Rescue log system. It also assists in reciting information by way of Facts, and also has a few extra useful functions like starsystem search.

Commands are written in standard !Command <Required Parameter> [Optional parameter] format. Each command detail section contains: the command's syntax (or usage), a description (along with any additional usage notes), aliases, permission required (on the FuelRats IRC server), and links to any directly related commands.

Command List

Click on commands for more details.

Command	Description
`!active <Client Name\|Board Index>`	Toggles the active status of a case.
`!assign <Client Name\|Board Index> <Rat1> [Rat2] [Rat3]...`	Assigns rats to a client's case.
`!clear <Client Name\|Board Index> [First Limpet Sender]`	Marks a case as closed, and adds the first limpet sender to the case if specified.
`!closed`	Lists the last 5 closed rescues, and their corresponding database IDs.
`!cmdr <Client Name\|Board Index> <CMDR name>`	Sets a client's in-game CMDR name.
`!codered <Client Name\|Board Index>`	Toggles the code red status of a case.
`!delete <Database ID\|List>`	Deletes a rescue, or lists rescues up for deletion.
`!epic <Client Name\|Board Index>`	Toggles the Epic status of a case.
`!flush`	Resets cached Rat-names. Helps with bugged rat 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 privileges.
`!inject <Client Name\|Board Index> <Text to Add>`	Injects a custom line of text into the client's case. If no case is found, a new case is opened.
`!ircnick <Client Name\|Board Index> <New Client Name>`	Sets a new client name for the case.
`!list [-iru@]`	List the currently active, open cases.
`!md <Client Name\|Board Index> <Reason for Deletion>`	Marks a case as closed, and adds it to the Marked for Deletion List™. (Don't use this without a reason!)
`!mdlist`	Shows the Marked for Deletion List™. (For cool people only)
`!mdremove <Database ID>`	Removes a case from the Marked for Deletion List™. (Does NOT reopen the case!)
`!pc <Client Name\|Board Index>`	Sets a case's platform to PC.
`!ps <Client Name\|Board Index>`	Sets a case's platform to PS4.
`!pwl <Client Name\|Board Index>`	Creates and shortens the link for the paperwork of a case.
!quiet	Displays the time since the last Ratsignal
`!quote <Client Name\|Board Index>`	Recites all known information for the specified open case
`!quoteid <Database ID>`	Recites all known information for the specified Database ID.
`!ratid <Rat Name>`	Gets a rats' ID from the API.
`!refreshboard`	Forcefully resets the board, and grabs fresh information from the API.
`!reindex`	Forcefully resets the board index with the API (thereby updating the dispatch web board).
`!reopen <Database ID>`	Reopens a case.
!plot [-b] <Current System> to <Destination System>	Plots large (over 1kly) routes using way-points at ~1ky intervals.
`!scan <query>`	Used for system name detection testing.
`!search <Search query>`	Searches for and suggests possible system names which match the given search query.
`!short <URL> [desired keyword]`	shortens a URL. If a keyword is specified, it will be used if it's not used already.
`!sub <Client Name\|Board Index> <Line Number> [Replacement Text]`	Substitute or delete an existing line of text to the client's case.
`!sys <Client Name\|Board Index> <System Name>`	Sets a case's system.
`!sysrefresh [-f]`	Refreshes the star-system database. Reports the last refresh time otherwise.
`!sysstats`	Provides statistics of the system search database.
`!title <Client Name\|Board Index> <Title to set>`	Sets the Operation title of a rescue.
!tweet <message>	Tweets a message from the FuelRats Alerts twitter account.
!tweetcase <Client Name\|Board Index>	Tweets a preformatted message to the FuelRats Alerts account, using case info.
`!unassign <Client Name\|Board Index> <Rat1> [rat2] [rat3]`	Removes rats from a client's case.
`!version`	Shows the bot's current version and up-time.
`!xb <Client Name\|Board Index>`	Sets a case's platform to Xbox.

Case Management

!active

Usage: !active <Client Name|Board Index>
Toggles the active status of a case.
Aliases: !activate, !inactive, !deactivate
Permission: Rat

!assign

Usage: !assign <Client Name|Board Index> <Rat1> [Rat2] [Rat3]...
Assigns rats to a client's case.
Aliases: !add, !go
Permission: Rat
Related: !unassign

!clear

Usage: !clear <Client Name|Board Index> [First Limpet Sender]
Marks a case as closed, and adds the first limpet sender to the case if specified.
Notes:
Setting the first limpet sender only works if the rat is properly registered with the API.
Dispatchers are encouraged to always specify the first limpet when able.
Aliases: !close
Permission: Rat
Related: !reopen

!cmdr

Usage: !cmdr <Client Name|Board Index> <CMDR name>
Sets a client's in-game CMDR name.
Aliases: !commander
Permission: Rat

!codered

Usage: !codered <Client Name|Board Index>
Toggles the code red status of a case.
Aliases: !casered, !cr
Permission: Rat

!delete

Usage: !delete <Database ID|List>
Deletes a rescue, or lists rescues up for deletion.
Permission: Overseer
Related: !md, !mdlist, !mdremove

!epic

Usage: !epic <Client Name|Board Index>
Toggles the Epic status of a case.
Permission: Rat

!grab

Usage: !grab <Client Name>
Grabs the last message the client sent, and adds it to their case.
Permission: Rat
Related: !inject, !sub

!inject

Usage: !inject <Client Name|Board Index> <Text to Add>
Injects a custom line of text into the client's case. If no case is found, a new case is opened.
Permission: Rat
Related: !grab, !sub

!ircnick

Usage: !ircnick <Client Name|Board Index> <New Client Name>
Sets a new client name for the case.
WARNING:
Changing the client name will change the name associated with the case. If the new name does not exactly match the client's IRC nick, certain functions might break!
Aliases: !nick, !nickname
Permission: Rat

!pc

Usage: !pc <Client Name|Board Index>
Sets a case's platform to PC.
Permission: Rat
Related: !xb, !ps

!ps

Usage: !ps <Client Name|Board Index>
Sets a case's platform to PS4.
Permission: Rat
Related: !pc, !xb

!pwl

Usage: !pwl <Client Name|Board Index>
Creates and shortens the link for the paperwork of a case.
Notes:
!clear performs the same operation while closing a case.
Aliases: !pwlink, !paperwork, !paperworklink
Permission: Rat

!quote

Usage: !quote <Client Name|Board Index>
Recites all known information for the specified open case.
Permission: Rat
Related: !list, !quoteid

!quoteid

Usage: !quoteid <Database ID>
Recites all known information for the specified Database ID.
Permission: Overseer
Related: !list, !quote

!reopen

Usage: !reopen <Database ID>
Reopens a case.
Notes:
May need to !reopen or !refreshboard (check below for usage) after opening a case to refresh the Dispatch Web Board.
Permission: Overseer
Related: !clear

!sub

Usage: !sub <Client Name|Board Index> <Line Number> [Replacement Text]
Substitute or delete an existing line of text to the client's case.
Notes:
DOES NOT perform auto-correction/auto-detection!
Permission: Rat
Related: !grab, !inject

!sys

Usage: !sys <Client Name|Board Index> <System Name>
Sets a case's system.
Aliases: !system, !loc, !location
Permission: Rat

!title

Usage: !title <Client Name|Board Index> <Title to set>
Sets the Operation title of a rescue.
Permission: Rat

!unassign

Usage: !unassign <Client Name|Board Index> <Rat1> [rat2] [rat3]
Removes rats from a client's case.
Aliases: !deassign, !rm, !remove, !standdown
Permission: Rat
Related: !assign

!xb

Usage: !xb <Client Name|Board Index>
Sets a case's platform to Xbox.
Aliases: (don't worry about it)
Permission: Rat
Related: !pc, !ps

Board Management

!closed

Usage: !closed
Lists the last 5 closed rescues, and their corresponding database IDs.
Aliases: !recent
Permission: Rat

!list

Usage: !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.
Permission: Rat
Related: !quote, !quoteid, !refreshboard

!refreshboard

Usage: !refreshboard
Forcefully resets the board, and grabs fresh information from the API. (Use when the Dispatch Web Board shows too many or not enough cases)
WARNING:
Use with care, usage resets board numbers.
(kinda went overBOARD with those aliases. hah. puns.)
Aliases: !resetboard, !forceresetboard, !forcerefreshboard, !frb, !fbr, !boardrefresh
Permission: Overseer
Related: !list, !reindex

!reindex

Usage: !reindex
Forcefully resets the board index with the API (thereby updating the dispatch web board). Use when the case numbers on the Dispatch Web Board don't match Mecha.
Permission: Rat
Related: !refreshboard

Marked for Deletion List™

!md

Usage: !md <Client Name|Board Index> <Reason for Deletion>
Marks a case as closed, and adds it to the Marked for Deletion List™. (Don't use this without a reason!)
Aliases: !mdadd
Permission: Rat
Related: !delete, !mdlist, !mdremove

!mdlist

Usage: !mdlist
Shows the Marked for Deletion List™. (For cool people only)
Permission: Overseer
Related: !delete, !md, !mdremove

!mdremove

Usage: !mdremove <Database ID>
Removes a case from the Marked for Deletion List™. (Does NOT reopen the case!)
Aliases: !mdremove, !mdr, !mdd, !mddeny
Permission: Overseer
Related: !delete, !md, !mdlist

System Search

!plot

Usage: !plot [-b] <starting system> to <destination system>
Plots large (over 1kly) routes using way-points at ~1ky intervals.
This operation is fairly intensive and "spammy". See "Special" below for limitations.
Parameters:
b: outputs all way-points batched together when the calculation is finished.
Permission: Rat
Special: This command is limited to a private message with MechaSqueak.
This command is limited to once every 30 minutes per rat.

!search

Usage: !search <Search query>
Searches for and suggests possible system names which match the given search query.
Permission: None
Related: !sysstats, !sysrefresh

!sysstats

Usage: !sysstats
Provides statistics of the system search database.
Permission: None
Related: !search, !sysrefresh

!sysrefresh

Usage: !sysrefresh [-f]
Refreshes the star-system database. Reports the last refresh time otherwise.
Parameters:
f: Forces the refresh even if data is stale.
Permission: Overseer (halfop|op)
Related: !search, !sysstats

Shortener

!short

Usage: !short <URL> [desired keyword]
shortens a url.
If a keyword is specified, it will be used if it's not used already.
Aliases: !shortener, !shorten
Permission: Rat

Twitter Module

!tweet

Usage: !tweet <Message over 5 characters>
Tweets a message from the FuelRats Alerts twitter account.
Notes:
Tweets will not be sent if a client name or system matching an active case is included. Use !tweetcase in that instance
Permission: Rat
Related: !tweetcase

!tweetcase

Usage: !tweetcase <Client Name|Board Index>
Tweets a preformatted message to the FuelRats Alerts account, using case info.
Notes:
The preformatted message is based off a distance to the case's landmark system. The message is formatted as follows: [PC] Rats needed for rescue! Call your jumps, Rats! -case 2feb51
Aliases: !tweetc
Permission: Rat
Related: !tweet

Debug/Utility

!flush

Usage: !flush
Resets cached Rat-names. Helps with bugged rat names on !assign.
Aliases: !resetnames, !rn, !flushnames, !fn
Permission: Rat

!host

Usage: !host
Shows you your current host to verify privileges.
Permission: None

!quiet

Usage: !quiet
Displays the time since the last Ratsignal.
Aliases: !last
Permission: Rat

!ratid

Usage: !ratid <Rat Name>
Gets a rats' ID from the API.
Aliases: !id
Permission: Rat

!scan

Usage: !scan <query>
Used for system name detection testing.
Permission: Rat

!version

Usage: !version
Shows the bot's current version and up-time.
Aliases: !uptime
Permission: None

Template

!

Usage: !
__
Aliases: !, !
Permission: Rat
Related: !, !

Space shortcuts

Page tree

Command-Reference