Commands | MechaSqueak Docs↑ TOC

Commands

Board

View, edit and manage cases on the board.

!activecase id/clientmessage...
Drilled Rat

Aliases: !inactive, !activate, !deactivate

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

Example:

!active 4 client left irc
In Channel Only

!addcaseclient nick
Drilled Rat

Aliases: !create

Create a new rescue case and add it to the board

Options:

  • -f
    Force mecha to add the case even if the client isn't in the channel
  • -o
    Set the case to use Odyssey game mode
  • -h
    Set the case to use Horizons game mode
  • -l
    Set the case to use Legacy game mode

Arguments:

  • --pcSet platform to PC
  • --xbSet platform to Xbox
  • --psSet platform to PS4
  • --modegame versionChange the game version for PC (l / h / o)
  • --crMark rescue as a code red
  • --syssystemSet the star system name of the rescue
  • --cmdrCMDR nameSet the CMDR name of the client (Only needed if it's different from the nickname).
  • --langlanguage codeSet the language of the rescue (English by default)

Example:

!addcase -f SpaceDawg --pc --mode h --sys NLTT 48288 --cmdr Space Dawg --lang ru
In Channel Only

!clearcase id/clientfirst limpet rat
Drilled Rat

Aliases: !close

Closes a case and posts the paperwork link

Consult this page to see when cases should be closed and when they should be deleted

Options:

  • -p
    Sends the paperwork to a rat without actually making them the first limpet of the rescue
  • -f
    Force Mecha to close a case without validating the first limpet

Arguments:

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

Example:

!clear -p 4 SpaceDawg --carrier
In Channel Only

!cmdrcase id/clientnew name...
Drilled Rat

Aliases: !client, !commander

Change the CMDR name of the client of this rescue.

Example:

!cmdr 4 SpaceDawg
In Channel Only

!crcase id/client
Drilled Rat

Aliases: !codered, !casered

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

Example:

!cr 4
In Channel Only

!go-localecase id/clientrats1rats2
Drilled Rat

Aliases: !assign, !add

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

Arguments:

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

Example:

!go-ru -a 4 SpaceDawg StuffedRat --carrier!go -a 4 SpaceDawg StuffedRat --carrier
In Channel Only

!gofr-localecase id/clientrats1rats2
Drilled Rat

Aliases: !assignfr, !frgo

Add rats to the rescue and instruct the client to add them as friends, also posts !fr

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

Arguments:

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

Example:

!gofr-ru -a 4 SpaceDawg StuffedRat --carrier!gofr -a 4 SpaceDawg StuffedRat --carrier
In Channel Only

!grabcase id/client/assigned ratnick
Drilled Rat

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

Example:

!grab 1 SpaceDawg
In Channel Only

!horizonscase id/client
Drilled Rat

Aliases: !hor, !h, !live, !horizons4, !h4

Changes a PC case to use the live Horizons expansion

Example:

!horizons 4
In Channel Only

!injectcase id/clienttext...
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 -f 4 NLTT 48288 PC CR
In Channel Only

!langcase id/clientlanguage code
Drilled Rat

Aliases: !language

Change the language of the client of this rescue.

Example:

!lang 4 de
In Channel Only

!legacycase id/client
Drilled Rat

Aliases: !leg, !horizons3, !h3

Changes a PC case to use legacy mode

Example:

!legacy 4
In Channel Only

!list
Drilled Rat

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

Cooldown: 2 minutes

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

Arguments:

  • --pcShow only PC cases
  • --xbShow only Xbox cases
  • --psShow only Playstation cases
  • --modegame versionShow only cases set to this game version (legacy, horizons, or odyssey)

Example:

!list -i --pc --mode h

!modecase id/clientgame version
Drilled Rat

Changes the PC expansion of a case

Example:

!mode 4 "3h / 4h / o"
In Channel Only

!nickcase id/clientnew nick
Drilled Rat

Aliases: !ircnick, !nickname

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

Example:

!nick 4 SpaceDawg
In Channel Only

!odysseycase id/client
Drilled Rat

Aliases: !ody, !o

Changes a PC case to use the Odyssey expansion

Example:

!odyssey 4
In Channel Only

!paperworkcase id/client
Drilled Rat

Aliases: !pwl

Retrieves the paperwork link for a case on the board.

Example:

!paperwork 4

!pccase id/client
Drilled Rat

Change the platform of this case to PC.

Example:

!pc 4
In Channel Only

!pscase id/client
Drilled Rat

Aliases: !ps4, !ps5

Change the platform of this case to PS4.

Example:

!ps 4
In Channel Only

!quotecase id/client
Drilled Rat

Show all information about a specific case

Example:

!quote 4

!sprepcase id/client
Drilled Rat

Silences the prep warning on a case

Example:

!sprep 4
In Channel Only

!subcase id/clientline numbernew text...
Drilled Rat

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

If no text is provided, the entry is deleted

Example:

!sub 4 1 Client is in EZ
In Channel Only

!sysccase id/clientnumber
Drilled Rat

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

Example:

!sysc 4 1
In Channel Only

!titlecase id/clientoperation title...
Drilled Rat

Aliases: !operation

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

Example:

!title 4 Beyond the Void
In Channel Only

!trashcase id/clientmessage...
Drilled Rat

Aliases: !md, !purge, !mdadd, !yeet

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

Consult this page to see when cases should be deleted

Options:

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

Example:

!trash -f 4 client left before rats were assigned
In Channel Only

!unassigncase id/clientrats1rats2
Drilled Rat

Aliases: !deassign, !rm, !remove, !standdown

Remove rats from the rescue

Example:

!unassign 4 SpaceDawg StuffedRat
In Channel Only

!xbcase id/client
Drilled Rat

Change the platform of this case to Xbox.

Example:

!xb 4
In Channel Only

Rescues

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

!clientpwclient name...
OverseerTech ratOperations teamModeratorNetwork administratorNetwork moderator

Aliases: !pwclient

Get paperwork link for a previous client by name.

Arguments:

  • --allLists ALL previous cases for this client

Example:

!clientpw SpaceDawg --all

!closednumber of cases
Drilled Rat

Aliases: !recent

Shows recently closed cases.

Example:

!closed 10

!deleterescue uuid1rescue uuid2
OverseerTech ratOperations teamModeratorNetwork administratorNetwork moderator

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

Example:

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

!deletealltime ago
Tech ratOperations teamModeratorNetwork administratorNetwork moderator

Aliases: !cleartrash

Delete all rescues currently in the trashlist

Example:

!deleteall 48h

!quoteidrescue uuid
Drilled Rat

Show all information about a case by UUID

Example:

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

!renamerescue uuidclient name...
OverseerTech ratOperations teamModeratorNetwork administratorNetwork moderator

Aliases: !renameid

Change the client name of a closed case

Example:

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

!reopenrescue uuid/client name
OverseerTech ratOperations teamModeratorNetwork administratorNetwork moderator

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

!restorerescue uuid
OverseerTech ratOperations teamModeratorNetwork administratorNetwork moderator

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

Restore a case from the trash list.

Example:

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

!sync
OverseerTech ratOperations teamModeratorNetwork administratorNetwork moderator

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

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

In Channel Only

!trashlist
Drilled Rat

Aliases: !mdlist, !purgelist, !listtrash

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

!uncloserecently closed case number
Drilled Rat

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

Example:

!unclose 5
In Channel Only

!unfiled
Drilled Rat

Aliases: !pwn, !paperworkneeded, !needspaperwork, !npw

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

Arguments:

  • --allShow all unfiled paperwork from the last 30 days (instead of just your own)

Example:

!unfiled --all
Private Message Only

Queue

Commands to manage the client queue

!dequeue
Drilled Rat

Aliases: !next

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

Cooldown: 5 seconds
In Channel Only

!maxclientsnumber of clients
Drilled Rat

Aliases: !maxload, !maxcases

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

Cooldown: 1 minute

Example:

!maxclients 10
In Channel Only

!queue
Drilled Rat

Get current information on the queue

Cooldown: 1 minute

!queuestatsstart date
Drilled Rat

Get statistics from the queueing system

Cooldown: 1 minute

Example:

!queuestats 2021-04-01

Facts

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

!addfactfact-languagefact message...
Tech ratOperations teamModeratorNetwork administratorNetwork moderator

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

Arguments:

  • --categoryinfohelp.command.addfact.category

Example:

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

!aliasfactalias
Tech ratOperations teamModeratorNetwork administratorNetwork moderator

Aliases: !aliasfact

Create an alias of an existing fact

Example:

!alias ircguide ircguides

!anyfacttargets1targets2
Tech ratOperations teamModeratorNetwork administratorNetwork moderator

Use a fact in the channel

Arguments:

  • --infoGet information about this fact such as who created it and when
  • --localesGet all the locales available for this fact

Example:

!anyfact SpaceDawg --info

!delaliasalias
Tech ratOperations teamModeratorNetwork administratorNetwork moderator

Delete an existing alias

Example:

!delalias ircguides

!delfactfact-language
Tech ratOperations teamModeratorNetwork administratorNetwork moderator

Delete a fact or an alias

Example:

!delfact pcquit-en

!factcatfactcategory
Tech ratOperations teamModeratorNetwork administratorNetwork moderator

Aliases: !setfactcat, !factcategory

Change the category of an existing fact

Example:

!factcat prep rescue

!facts

Aliases: !listfacts, !factlist, !fact

View the list of facts

Arguments:

  • --localesList all the locales currently available

Example:

!facts --locales

!searchfactssearch term...

Aliases: !factsearch, !factssearch

Search for facts

Example:

!searchfacts log in to open

!setfactfact-languagefact message...
Tech ratOperations teamModeratorNetwork administratorNetwork moderator

Update an existing fact

Example:

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

Utility

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

!alertmessage...
Drilled DispatchOverseerTech ratOperations teamModeratorNetwork administratorNetwork moderator

Aliases: !squeak, !tweet

Send a message via Mastodon & BlueSky

The Mastodon is at fuelratsalerts@mastodon.localecho.net and the BlueSky at alerts.fuelrats.com

Example:

!alert Need rats urgently for two PS4 cases in the bubble
In Channel Only

!alertcasecase id/client
Drilled Rat

Aliases: !alertc, !squeakcase, !squeakc, !tweetcase, !tweetc

Notify users that rats are needed on a case via Mastodon & Bluesky

The Mastodon is at fuelratsalerts@mastodon.localecho.net and the BlueSky at alerts.fuelrats.com

Example:

!alertcase 4
In Channel Only

!announcechannelclient nameclient nickPC/XB/PSsystem...
TrainerOverseerTech ratOperations teamModeratorNetwork administratorNetwork moderator

Create a rescue announcement in a drill channel

Arguments:

  • --crAnnounces the rescue as a code red
  • --langlanguage codeSets the language of the announced rescue to a specific language code
  • --modegame versionAnnounces the rescue with a specific PC game version (l / h / o)

Example:

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

!distancedeparture system / case id / client namearrival system / case id / client name...

Aliases: !plot, !distanceto

Calculate the distance between two star systems

Cooldown: 30 seconds

Arguments:

  • --rangejump rangeDefine the desired ship jump range for the Spansh plot link

Example:

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

!gametime

Aliases: !utc

See the current time in game time / UTC

Cooldown: 5 minutes

!landmarksystem name...

Aliases: !sysinfo, !edsm

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

Cooldown: 15 seconds

Example:

!landmark NLTT 48288

!medestinationmessage...
Tech ratOperations teamModeratorNetwork administratorNetwork moderator

Aliases: !action, !emote

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

Example:

!me #ratchat takes all the snickers

!msgdestinationmessage...
Tech ratOperations teamModeratorNetwork administratorNetwork moderator

Aliases: !say

Make the bot send an IRC message somewhere.

Example:

!msg #ratchat squeak!

!needsrats
Drilled Rat

Aliases: !needrats, !nr

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

Cooldown: 5 minutes

!psncase id/username...

See information about a playstation user

Cooldown: 30 seconds

Example:

!psn SpaceDawg

!rolldices

Aliases: !dice

Roll a dice

Cooldown: 1 minute

Example:

!roll 2d8

!savelogs
TrainerOverseerTech ratOperations teamModeratorNetwork administratorNetwork moderator

Aliases: !stoplogs

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

In Channel Only

!sctimedistance...

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.

Cooldown: 30 seconds

Arguments:

  • --scomax speedhelp.command.sctime.sco

Example:

!sctime 2500ls --sco 7000

!shortenurlcustom link
Verified

Aliases: !short, !shortener

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
Private Message Only

!startlogs
TrainerOverseerTech ratOperations teamModeratorNetwork administratorNetwork moderator

Start a new logging session in this channel

In Channel Only

!stationreference system / case id / client name...

Aliases: !stations

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

Cooldown: 30 seconds

Options:

  • -p
    Include planetary outposts in results
  • -l
    Require the station to have a size L (large) landing pad

Arguments:

  • --legacyDo not include stations created after the player colonization update

Example:

!station -p Sagittarius A* --legacy

!sysstats

Aliases: !syscount, !systems

See statistics about the systems API.

Cooldown: 5 minutes

!systemcase id/clientsystem name...
Drilled Rat

Aliases: !sys, !loc, !location

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

Options:

  • -f
    Prevents Mecha from automatically correcting the system name

Example:

!system -f 4 NLTT 48288
In Channel Only

!tcasecase id/clientmessage...

Aliases: !tc

Translates a message to the client's language and replies in the rescue channel as you

Consult this page for a guide on how to use Mecha translation

Example:

!tcase 4 Help is on the way!
Private Message Only

!timezonetime in timezone...

Aliases: !tz

Convert a time to another timezone

Cooldown: 5 minutes

Example:

!timezone 3pm EST in CET

!translate-localemessage...

Aliases: !t

Translate a message to another language

Consult this page for a guide on how to use Mecha translation
Cooldown: 30 seconds

Example:

!translate-fr Help is on the way!!translate Help is on the way!

!translatemechannellanguage codemessage...

Aliases: !tme

Translate a message to another language and sends the message to a channel as you

Consult this page for a guide on how to use Mecha translation
Cooldown: 30 seconds

Example:

!translateme #fuelrats fr Help is on the way!
Private Message Only

!transsubmessage type
Verified

Aliases: !tsub

Subscribe to automatic translations of client messages by either private message, or notice

Consult this page for a guide on how to use Mecha translation

Example:

!transsub notice
Private Message Only

!transunsub
Verified

Aliases: !tunsub

Subscribe to automatic translations of client messages by either private message, or notice

Consult this page for a guide on how to use Mecha translation
Private Message Only

!version

Aliases: !uptime

See version information about the bot.

Cooldown: 2 minutes

!xblcase id/gamertag...

Aliases: !gamertag

See information about an xbox gamertag

Cooldown: 30 seconds

Example:

!xbl SpaceDawg

Account

Commands to manage your Fuel Rats account

!activeratplatform
Verified

Aliases: !assigncheck, !assigntest

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

Cooldown: 5 minutes

Example:

!activerat PC

!addpermitsystem name...
Verified

Aliases: !permitadd

Add the permit belonging to this system to your current CMDR

Example:

!addpermit NLTT 48288
Private Message Only

!changeemailemail
Verified

Aliases: !changemail

Change your Fuel Rats account email address

Arguments:

  • --usernickname/user idChange another user's email address (requires admin permissions)

Example:

!changeemail spacedawg@fuelrats.com --user SpaceDawg
Private Message Only

!delpermitpermit name...
Verified

Aliases: !permitdel

Delete this permit from your current CMDR

Example:

!delpermit Pilot's Federation District
Private Message Only

!mymodegame version
Verified

Aliases: !myversion

Informs Mecha which PC game version you are using

Accepted values: legacy/leg/l, horizons/hor/h, odyssey/ody/o

Example:

!mymode h
Private Message Only

!permits
Verified

List all the permits currently belonging to your account

Private Message Only

!whoami

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

Cooldown: 1 minute

!whoisnickname
Verified

Aliases: !ratid, !who, !id

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

Options:

  • -@
    Display user and rat UUIDs

Example:

!whois -@ SpaceDawg
Private Message Only

Other

Commands that don't fit into any category

!quiet
Verified

Aliases: !last

Displays the amount of time since the last rescue

Cooldown: 5 minutes

Arguments:

  • --pcShow the last time there was a case on PC (Horizons)
  • --xbShow the last time there was a case on Xbox
  • --psShow the last time there was a case on PS4/PS5
  • --modegame versionShows last time for another PC game version (l / h / o)

Example:

!quiet --pc --mode h

Management

Admin Commands to manage MechaSqueak and the API

!addgroupnickname/user idpermission group
Tech ratOperations teamModeratorNetwork administratorNetwork moderator

Aliases: !addrole

Add a permission to a person

Available permission groups:
  • owner Special snowflake
  • admin Network moderator
  • netadmin Network administrator
  • moderator Moderator
  • operations Operations team
  • techrat Tech rat
  • overseer Overseer
  • trainer Trainer
  • dispatch Drilled Dispatch
  • rat Drilled Rat
  • verified Verified
  • merch Quartermaster
  • developer Developer

Example:

!addgroup SpaceDawg overseer

!delgroupnickname/user idpermission group
Tech ratOperations teamModeratorNetwork administratorNetwork moderator

Aliases: !delreole

Remove a permission from a person

Available permission groups:
  • owner Special snowflake
  • admin Network moderator
  • netadmin Network administrator
  • moderator Moderator
  • operations Operations team
  • techrat Tech rat
  • overseer Overseer
  • trainer Trainer
  • dispatch Drilled Dispatch
  • rat Drilled Rat
  • verified Verified
  • merch Quartermaster
  • developer Developer

Example:

!delgroup SpaceDawg overseer

!flushnickname
OverseerTech ratOperations teamModeratorNetwork administratorNetwork moderator

Aliases: !clearname, !invalidate

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

Example:

!flush SpaceDawg

!flushnames
Tech ratOperations teamModeratorNetwork administratorNetwork moderator

Aliases: !clearnames, !flushall, !invalidateall

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

!groupsnickname
Tech ratOperations teamModeratorNetwork administratorNetwork moderator

Aliases: !permissions, !roles

Lists the permissions of a specific person

Example:

!groups SpaceDawg

!relaunchupdate link
Tech ratOperations teamModeratorNetwork administratorNetwork moderator

Restarts MechaSqueak

Example:

!relaunch https://fuelrats.com/

!suspendnickname/user idtimespan
Tech ratOperations teamModeratorNetwork administratorNetwork moderator

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

Example:

!suspend SpaceDawg 7d

!syncgroupsnickname/user id
Tech ratOperations teamModeratorNetwork administratorNetwork moderator

Syncs a person's permissions and updates their vhost

Available permission groups:
  • owner Special snowflake
  • admin Network moderator
  • netadmin Network administrator
  • moderator Moderator
  • operations Operations team
  • techrat Tech rat
  • overseer Overseer
  • trainer Trainer
  • dispatch Drilled Dispatch
  • rat Drilled Rat
  • verified Verified
  • merch Quartermaster
  • developer Developer

Example:

!syncgroups SpaceDawg