Command-Reference

Board

View, edit and manage cases on the board.

!addcase <client nick> [--pc] [--xb] [--ps] [--mode <game version>] [--cr] [--sys <system>] [--cmdr <CMDR name>] [--lang <language code>]

Aliases: !create

Permissions: Drilled Rat

Create a new rescue case and add it to the board

Options:

--pc Set platform to PC

--xb Set platform to Xbox

--ps Set platform to PS4

--mode <game version> Change the game version for PC (h3 / h4 / o)

--cr Mark rescue as a code red

--sys <system> Set the star system name of the rescue

--cmdr <CMDR name> Set the CMDR name of the client (Only needed if it's different from the nickname).

--lang <language code> Set the language of the rescue (English by default)

Example:

!addcase SpaceDawg --pc --mode h3 --sys NLTT 48288 --cmdr Space Dawg --lang ru

!list [-iaqru@] [--pc] [--xb] [--ps] [--mode <game version>]

Permissions: Drilled Rat

List all the rescues on the board. Use flags to filter results or change what is displayed

Options:

-i Show only inactive cases

-a Show only active cases

-q Show only queued cases

-r Show only with assigned rats

-u Show only with no assigned rats

-@ Display case UUIDs

--pc Show only PC cases

--xb Show only Xbox cases

--ps Show only Playstation cases

--mode <game version> Show only cases set to this game version (horizons 3.8, horizons 4.0, or odyssey)

Example:

!list --mode h3

!clear [-fp] <case id/client> [first limpet rat]

Aliases: !close

Permissions: Drilled Rat

Closes a case and posts the paperwork link. Optional parameter takes the nick of the person that got first limpet (fuel+).

Consult https://confluence.fuelrats.com/pages/releaseview.action?pageId=2687182 to see when cases should be closed and when they should be deleted.

Options:

-f Force Mecha to close a case without validating the first limpet

-p Sends the paperwork to a rat without actually making them the first limpet of the rescue

Example:

!clear 4 SpaceDawg

!trash [-f] <case id/client> <message...>

Aliases: !md !purge !mdadd !yeet

Permissions: Drilled Rat

Moves a case to the trash list with a message describing why it was deleted

Consult https://confluence.fuelrats.com/pages/releaseview.action?pageId=2687182 to see when cases should be deleted.

Options:

-f Forces a case to be trashed even if it has rats assigned

Example:

!trash 4 client left before rats were assigned

!paperwork <case id/client>

Aliases: !pwl

Permissions: Drilled Rat

Retrieves the paperwork link for a case on the board.

Example:

!paperwork 4

!sysc <case id/client> <number>

Permissions: Verified User

Correct the system of a case to one of the options provided by the system correction search.

Example:

!sysc 4 1

!sprep <case id/client>

Permissions: Drilled Rat

Silences the prep warning on a case

Example:

!sprep 4

!go [-af] <case id/client> [rats 1] [rats 2] [rats 3] [--carrier]

Aliases: !assign !add

Permissions: Drilled Rat

Add rats to the rescue and instruct the client to add them as friends.

Options:

-a Include already assigned rats in the message telling clients who to add

-f Force mecha to assign someone even if it can't find a valid rat for them

--carrier Allows you to assign a rat from a different platform using a fleet carrier

Example:

!go 4 SpaceDawg StuffedRat

!gofr [-af] <case id/client> [rats 1] [rats 2] [rats 3] [--carrier]

Aliases: !assignfr !frgo

Permissions: Drilled Rat

Add rats to the rescue and instruct the client to add them as friends, also inform the client how to add friends.

Options:

-a Include already assigned rats in the message telling clients who to add

-f Force mecha to assign someone even if it can't find a valid rat for them

--carrier Allows you to assign a rat from a different platform using a fleet carrier

Example:

!gofr 4 SpaceDawg StuffedRat

!unassign <case id/client> <rats 1> <rats 2> <rats 3>

Aliases: !deassign !rm !remove !standdown

Permissions: Drilled Rat

Remove rats from the rescue

Example:

!unassign 4 SpaceDawg StuffedRat

!active <case id/client> [message...]

Aliases: !inactive !activate !deactivate

Permissions: Drilled Rat

Toggle a case between active or inactive, add an optional message that gets inserted into quotes.

Example:

!active 4 client left irc

!cmdr <case id/client> <new name...>

Aliases: !client !commander

Permissions: Drilled Rat

Change the CMDR name of the client of this rescue.

Example:

!cmdr 4 SpaceDawg

!nick <case id/client> <new nick>

Aliases: !ircnick !nickname

Permissions: Drilled Rat

Change the IRC nick associated with the client of this rescue.

Example:

!nick 4 SpaceDawg

!lang <case id/client> <language code>

Aliases: !language

Permissions: Drilled Rat

Change the language of the client of this rescue.

Example:

!lang 4 de

!cr <case id/client>

Aliases: !codered !casered

Permissions: Drilled Rat

Toggle the case between code red (on emergency oxygen) status or not.

Example:

!cr 4

!title <case id/client> <operation title...>

Aliases: !operation

Permissions: Drilled Rat

Set the operations title of this rescue, used to give a unique name to special rescues

Example:

!title 4 Beyond the Void

!mode <case id/client> <game version>

Permissions: Drilled Rat

Changes the PC expansion of a case

Example:

!mode 4 "3h / 4h / o"

!horizons3 <case id/client>

Aliases: !h3

Permissions: Drilled Rat

Changes a PC case to use the 3.8 Horizons expansion

Example:

!horizons3 4

!horizons4 <case id/client>

Aliases: !h4

Permissions: Drilled Rat

Changes a PC case to use the 4.0 Horizons expansion

Example:

!horizons4 4

!odyssey <case id/client>

Aliases: !ody !o

Permissions: Drilled Rat

Changes a PC case to use the Odyssey expansion

Example:

!odyssey 4

!xb <case id/client>

Permissions: Drilled Rat

Change the platform of this case to Xbox.

Example:

!xb 4

!pc <case id/client>

Permissions: Drilled Rat

Change the platform of this case to PC.

Example:

!pc 4

!ps <case id/client>

Aliases: !ps4 !ps5

Permissions: Drilled Rat

Change the platform of this case to PS4.

Example:

!ps 4

!quote <case id/client>

Permissions: Drilled Rat

Show all information about a specific case

Example:

!quote 4

!grab <case id/client/assigned rat>

Permissions: Drilled Rat

Grab the last message by the client or assigned rat and add it to an existing rescue

Example:

!grab SpaceDawg

!inject [-f] <case id/client> <text...>

Permissions: Drilled Rat

Add some new information to the case, if one does not exist, create one with this information

Options:

-f Forces a new case to be created from this inject bypassing all restrictions

Example:

!inject 4 NLTT 48288 PC CR

!sub <case id/client> <line number> [new text...]

Permissions: Drilled Rat

Change a text entry in the rescue replacing its contents with new text

Example:

!sub 4 1 Client is in EZ

Rescues

View, edit and manage rescues that have already been completed.

!sync

Aliases: !fbr !refreshboard !reindex !resetboard !forcerestartboard !forcerefreshboard !frb !boardrefresh

Permissions: Overseer, Tech rat, Moderator, Operations team, Network moderator, Network administrator

Force MechaSqueak to perform a synchronization of data between itself and the rescue server.

Example:

!sync

!closed [number of cases]

Aliases: !recent

Permissions: Drilled Rat

Shows recently closed cases.

Example:

!closed 10

!delete <rescue uuid>

Permissions: Overseer, Tech rat, Moderator, Operations team, Network moderator, Network administrator

Delete a rescue by UUID, cannot be used on a rescue that is currently on the board.

Example:

!delete 3811e593-160b-45af-bf5e-ab8b5f26b718

!deleteall

Aliases: !cleartrash

Permissions: Tech rat, Moderator, Network moderator, Network administrator

Delete all rescues currently in the trashlist

Example:

!deleteall

!trashlist

Aliases: !mdlist !purgelist !listtrash

Permissions: Drilled Rat

Shows all the rescues that have been added to the trash list but not yet deleted

Example:

!trashlist

!restore <rescue uuid>

Aliases: !mdremove !trashremove !mdr !tlr !trashlistremove !mdd !mddeny

Permissions: Overseer, Tech rat, Moderator, Operations team, Network moderator, Network administrator

Restore a case from the trash list.

Example:

!restore 3811e593-160b-45af-bf5e-ab8b5f26b718

!unfiled

Aliases: !pwn !paperworkneeded !needspaperwork !npw

Permissions: Drilled Rat

Get a list of rescues that have not had their paperwork completed.

Example:

!unfiled

!quoteid <rescue uuid>

Permissions: Drilled Rat

Show all information about a case by UUID

Example:

!quoteid 3811e593-160b-45af-bf5e-ab8b5f26b718

!reopen <rescue uuid/client name>

Permissions: Overseer, Tech rat, Moderator, Operations team, Network moderator, Network administrator

Add a previously closed case back onto the board

Use a rescue UUID, or the name of the client (will fetch the latest created one in this case)

Example:

!reopen 3811e593-160b-45af-bf5e-ab8b5f26b718

!unclose <recently closed case number>

Permissions: Drilled Rat

Add a previously closed case back onto the board by its previous case number.

Example:

!unclose 5

!clientpw <client name...> [--all]

Aliases: !pwclient

Permissions: Overseer, Tech rat, Moderator, Operations team, Network moderator, Network administrator

Get paperwork link for a previous client by name.

Options:

--all Lists ALL previous cases for this client

Example:

!clientpw SpaceDawg

!renameid <rescue uuid> <client name>

Permissions: Overseer, Tech rat, Moderator, Operations team, Network moderator, Network administrator

Change the client name of a closed case

Example:

!renameid 3811e593-160b-45af-bf5e-ab8b5f26b718 SpaceDawg

Queue

Commands to manage the client queue

!queue

Permissions: Drilled Rat

Get current information on the queue

Example:

!queue

!queuestats [start date]

Permissions: Drilled Rat

Get statistics from the queueing system

Example:

!queuestats 2021-04-01

!dequeue

Aliases: !next

Permissions: Drilled Rat

Manually move the next client from the queue into the rescue channel

Example:

!dequeue

!maxclients [number of clients]

Aliases: !maxload !maxcases

Permissions: Drilled Rat

See how many rescues are allowed at once before clients get put into a queue, provide a number as an argument to change the value

Example:

!maxclients 10

Facts

View, edit and manage the list of information commands such as !prep

!facts [--locales]

Aliases: !listfacts !factlist !fact

View the list of facts

Options:

--locales List all the locales currently available

Example:

!facts

!addfact <fact-language> <fact message...>

Permissions: Tech rat, Moderator, Network moderator, Network administrator

Add a new fact or a new language onto an existing fact

Example:

!addfact pcquit-en Get out it's gonna blow!

!setfact <fact-language> <fact message...>

Permissions: Tech rat, Moderator, Network moderator, Network administrator

Update an existing fact

Example:

!setfact pcquit-en Get out it's gonna blow!

!delfact <fact-language>

Permissions: Tech rat, Moderator, Network moderator, Network administrator

Delete a fact or an alias

Example:

!delfact pcquit-en

!alias <fact> <alias>

Aliases: !aliasfact

Permissions: Tech rat, Moderator, Network moderator, Network administrator

Create an alias of an existing fact

Example:

!alias ircguide ircguides

!delalias <alias>

Permissions: Tech rat, Moderator, Network moderator, Network administrator

Delete an existing alias

Example:

!delalias ircguides

!anyfact [targets 1] [targets 2] [targets 3] [--info] [--locales]

Permissions: Tech rat, Moderator, Network moderator, Network administrator

Use a fact in the channel

Options:

--info Get information about this fact such as who created it and when

--locales Get all the locales available for this fact

Example:

!anyfact SpaceDawg

Utility

Various commands that provide utility for rats and dispatches, such as tweeting a case or looking up a star system

!needsrats

Aliases: !needrats !nr

Permissions: Drilled Rat

Get a list of cases that currently require rats to call jumps

Example:

!needsrats

!sysstats

Aliases: !syscount !systems

See statistics about the systems API.

Example:

!sysstats

!sctime [-g] <distance...>

Aliases: !sccalc !traveltime

Calculate supercruise travel time.

By default the command assumes that you are starting at the entry point to a system and accelerating away from all gravitational bodies, if you are going towards another gravitational body you can use the -g option.

Options:

-g Calculate going from one gravitational body to another, rather than towards deep space

Example:

!sctime 2500ls

!version

Aliases: !uptime

See version information about the bot.

Example:

!version

!gametime

Aliases: !utc

See the current time in game time / UTC

Example:

!gametime

!timezone <time in timezone...>

Aliases: !tz

Convert a time to another timezone

Example:

!timezone 3pm EST in CET

!roll <dices>

Roll a dice

Example:

!roll 2d8

!announce <channel> <client name> <client nick> <PC/XB/PS> <system...> [--cr] [--lang <language code>] [--mode <game version>]

Permissions: Trainer, Overseer, Tech rat, Moderator, Operations team, Network moderator, Network administrator

Create a rescue announcement in a drill channel

Options:

--cr Announces the rescue as a code red

--lang <language code> Sets the language of the announced rescue to a specific language code

--mode <game version> Announces the rescue with a specific PC game version (h3 / h4 / o)

Example:

!announce #drillrats "Space Dawg" SpaceDawg PC NLTT 48288 --lang ru --mode h3

!xbl <case id/gamertag...>

Aliases: !gamertag

See information about an xbox gamertag

Example:

!xbl SpaceDawg

!psn <case id/username...>

See information about a playstation user

Example:

!psn SpaceDawg

!search <system name...>

Search for a system in the galaxy database.

Example:

!search NLTT 48288

!landmark <system name...>

Search for a star system's proximity to known landmarks such as Sol, Sagittarius A* or Colonia.

Example:

!landmark NLTT 48288

!distance <departure system / case id / client name> <arrival system / case id / client name...> [--range <jump range>]

Aliases: !plot !distanceto

Calculate the distance between two star systems

Options:

--range <jump range> Define the desired ship jump range for the Spansh plot link

Example:

!distance "NLTT 48288" Sagittarius A* --range 68

!station [-pl] <reference system / case id / client name...>

Aliases: !stations

Get the nearest station to a system, use a system name, case ID, or client name

Options:

-p Include planetary outposts in results

-l Require the station to have a size L (large) landing pad

Example:

!station Sagittarius A*

!system [-f] <case id/client> <system name...>

Aliases: !sys !loc !location

Permissions: Drilled Rat

Change the star system of this rescue to a different one.

Options:

-f Prevents Mecha from automatically correcting the system name

Example:

!system 4 NLTT 48288

!shorten <url> [custom link]

Aliases: !short !shortener

Permissions: Verified User

Create a t.fuelr.at short url to another url, optionally set a custom url rather than a random.

Example:

!shorten https://www.youtube.com/watch?v=dQw4w9WgXcQ importantinfo

!tweet <message...>

Permissions: Drilled Dispatch, Overseer, Tech rat, Moderator, Operations team, Network moderator, Network administrator

Send a tweet from @FuelRatAlerts

Example:

!tweet Need rats urgently for two PS4 cases in the bubble

!tweetcase <case id/client>

Aliases: !tweetc

Permissions: Drilled Rat

Tweet information about a case from @FuelRatAlerts

Example:

!tweetcase 4

!msg <destination> <message...>

Aliases: !say

Permissions: Tech rat, Moderator, Network moderator, Network administrator

Make the bot send an IRC message somewhere.

Example:

!msg #ratchat squeak!

!me <destination> <message...>

Aliases: !action !emote

Permissions: Tech rat, Moderator, Network moderator, Network administrator

Make the bot send an IRC action (/me) somewhere.

Example:

!me #ratchat takes all the snickers

!startlogs

Permissions: Trainer, Overseer, Tech rat, Moderator, Operations team, Network moderator, Network administrator

Start a new logging session in this channel

Example:

!startlogs

!savelogs

Aliases: !stoplogs

Permissions: Trainer, Overseer, Tech rat, Moderator, Operations team, Network moderator, Network administrator

Save logs from a drill or training session, use after the session has completed

Example:

!savelogs

Account

Commands to manage your Fuel Rats account

!whoami

Check the Fuel Rats account information the bot is currently associating with your nick

Example:

!whoami

!whois <nickname>

Aliases: !ratid !who !id

Permissions: Verified User

Check the Fuel Rats account information the bot is associating with someone's nick.

Example:

!whois SpaceDawg

!activerat <platform>

Aliases: !assigncheck !assigntest

Permissions: Verified User

Check what CMDR name mecha would currently assign to a case based on your nickname

Example:

!activerat PC

!changeemail <email>

Aliases: !changemail

Permissions: Verified User

Change your Fuel Rats account email address

Example:

!changeemail spacedawg@fuelrats.com

!permits

Permissions: Verified User

Add the permit belonging to this system to your account

Example:

!permits

!addpermit <system name...>

Aliases: !permitadd

Permissions: Verified User

Add the permit belonging to this system to your current CMDR

Example:

!addpermit NLTT 48288

!delpermit <permit name...>

Aliases: !permitdel

Permissions: Verified User

Delete this permit from your current CMDR

Example:

!delpermit Pilot's Federation District

!mymode <game version>

Aliases: !myversion

Permissions: Verified User

Informs Mecha which PC game version you are using

Example:

!mymode h3

Other

Commands that don't fit into any category

!quiet [--pc] [--xb] [--ps] [--mode <game version>]

Aliases: !last

Permissions: Verified User

Displays the amount of time since the last rescue

Options:

--pc Show the last time there was a case on PC (Horizons)

--xb Show the last time there was a case on Xbox

--ps Show the last time there was a case on PS4/PS5

--mode <game version> Shows last time for another PC game version (h3 / h4 / o)

Example:

!quiet --mode h3

Management

Admin Commands to manage MechaSqueak and the API

!flushnames

Aliases: !clearnames !flushall !invalidateall

Permissions: Tech rat, Moderator, Network moderator, Network administrator

Invalidate the bots cache of API user data and fetch it again for all users.

Example:

!flushnames

!relaunch [update link]

Permissions: Tech rat, Moderator, Network moderator, Network administrator

Invalidate the bots cache of API user data and fetch it again for all users.

Example:

!relaunch https://fuelrats.com/

!flush <nickname>

Aliases: !clearname !invalidate

Permissions: Overseer, Tech rat, Moderator, Operations team, Network moderator, Network administrator

Invalidate a single name in the cache and fetch it again.

Example:

!flush SpaceDawg

!groups <nickname>

Aliases: !permissions

Permissions: Tech rat, Moderator, Network moderator, Network administrator

Lists the permissions of a specific person

Example:

!groups SpaceDawg

!addgroup <nickname/user id> <permission group>

Permissions: Tech rat, Moderator, Network moderator, Network administrator

Add a permission to a person

Example:

!addgroup SpaceDawg overseer

!delgroup <nickname/user id> <permission group>

Permissions: Tech rat, Moderator, Network moderator, Network administrator

Remove a permission from a person

Example:

!delgroup SpaceDawg overseer

!suspend <nickname/user id> <timespan>

Permissions: Tech rat, Moderator, Network moderator, Network administrator

Suspend a user account, accepts IRC style timespans (0 for indefinite).

Example:

!suspend SpaceDawg 7d