HalpyBOT Command and Fact Listing

What is HalpyBOT?

HalpyBOT (v2.0.0-alpha) is our Second-Generation IRC Assistant, designed to help Seals get limpets on target faster and more painless than ever before. It comes with a lot of features, and is easy to build upon with new features. Most notably for Seals, it powers our custom commands and functions. This command reference will help you understand the power that HalpyBOT puts in your hand.

Want to check the current status of HalpyBOT? Click Here: HalpyBOT Status Page

Commands vs Facts

You may see two different terms thrown around a lot - Commands and Facts. In short, Commands do something while Facts are just spit out as programmed. If the response needs to be calculated, it's a command. If it's pre-programmed recital, it's a fact.

Case Board

The Case Board serves as a repository for all active cases. When a client initiates a case, it is assigned a unique ID and added to the board. Each entry encompasses vital details such as client name, system, IRC nick, along with specifics regarding the case type (Seal, Black, Blue, KF) and pertinent details for each category. Additionally, it tracks the dispatching and response personnel for each case. Dispatchers have the ability to append notes to the case, detailing factors like the source of damage, notable issues, or information regarding meetup times. Upon filing PW, cases with identical client names are automatically designated as completed and are subsequently removed from the publicly accessible board.

There is currently an issue where some cases are not automatically cleared and have to be manually removed from the case board by the Cyberseals or Admins. This issue occurs if the client name on the case board and the paperwork do not match exactly, for example if someone made a typo, if the client replaced spaces with underscores or dots or if they included the term cmdr in front of their name.

HalpyBOT Command Listing

Below are the HalpyBOT commands that may be used by Seals. You can also access the help documentation by running the !help command.

General Commands

Command	Arguments	Use
!help	[command]	Provides a contextual help for the various features in HalpyBOT.
!about		Provide information about HalpyBOT. Responds in DMs, regardless of where run.
!welcome	[Client Name or Case ID]	Welcome a client and disables Reminders for that case.
!spansh	[System/CMDR/Case ID] : [System/CMDR/Case ID] : [Jump Range]	Get spansh jump counts and a link from pojntA to pointB.
!dist	[System/CMDR/Case ID] : [System/CMDR/Case ID] : <Jump Range>	Check the distance between two points in EDSM and optionally calculate an estimated jump count.
!diversion	[System/CMDR/Case ID]	Calculate the 5 closest FDEV-placed structures with repair capability to given location.
!dssa	[System/CMDR/Case ID]	Check for the closest DSSA carrier to a given location.
!landmark	[System/CMDR/Case ID]	Check if a given point is nearby a given Landmark System.
!lookup	[System/CMDR/Case ID]	Check if a system exists in EDSM
!coords	[Set of coordinates, X Y and Z seperated by spaces]	Find a system known to EDSM within a 100ly radius of the provided coordinates
!locate	[CMDR Name]	Check if a CMDR exists and shares their location in EDSM

Case Board Management

Command	Arguments	Use	Requirements
!listboard		Print out the current cases on the Board in DMs.	Drilled Seals Only, must be run in a channel.
!listcase	[Case ID]	# Print out the current cases on the Board in DMs.	Drilled Seals Only, must be run in a channel.
!status	[Case ID] [New Status]	Set the updated case status. Valid options include `ACTIVE`, `DELAYED`, and `INACTIVE`	Drilled Seals Only, must be run in a channel.
!last		Check the time since the last case.	Drilled Seals Only, must be run in a channel.
!delcase, !remcase	[Case ID]	Administratively removes a case from the board, in case something screwed up. Not to be done lightly!	Admin or Cyberseal

Case Detail Management

Command	Arguments	Use	Requirements
!rename	[Case ID] [New Client Name]	Rename the client for a given case.	Drilled Seals Only, must be run in a channel.
!ircn	[Case ID] [Valic IRC User]	Rename the client for a given case.	Drilled Seals Only, must be run in a channel.
!system	[Case ID] [New System]	Set the updated client's System.	Drilled Seals Only, must be run in a channel.
!hull	[Case ID] [New Hull %]	Set the updated case hull percentage.	Drilled Seals Only, must be run in a channel.
!casetype	[Case ID] {New Case Type]	Set the updated case type. Valid options include `SEAL`, `BLACK`, `BLUE`, and `FISH`.	Drilled Seals Only, must be run in a channel.
!platform	[Case ID] [New Case Platform]	Set the updated case platform. Valid options include `ODYSSEY`, `LIVE`, `LEGACY`, `XBOX`and `PLAYSTATION`.	Drilled Seals Only, must be run in a channel.
!planet	[Case ID] [New Planet]	Edit the planet for a given KF Case.	Drilled Seals Only, must be run in a channel.
!casecoords	[Case ID] [X Coordinate] [Y Coordinate]	Edit the planetary coordinates for a given KF Case.	Drilled Seals Only, must be run in a channel.
!kftype	[Case ID] [New Type]	Change the case type between KF subtypes. Valid options include `LIFT`, `GOLF`, `PUCK`and `PICK`.	Drilled Seals Only, must be run in a channel.
!o2time	[Case ID] [O2 Time in `MM:SS`]	Edit the planetary coordinates for a given KF Case.	Drilled Seals Only, must be run in a channel.
!synth	[Case ID] [Yes/True/No/False]	Toggle if a CMDR has synths available for a given case.	Drilled Seals Only, must be run in a channel.
!canopy	[Case ID] [Yes/True/No/False]	Toggle if the canopy is broken for a given case.	Drilled Seals Only, must be run in a channel.

Case Responder Management

Command	Arguments	Use	Requirements
!welcome	[Client Name or Case ID]	Welcome a client and disables Reminders for that case.
!silencewelcome	[Client Name or Case ID]	Disables welcome reminders for a case.
!go	[Client Name or Case ID] [New Responders]	Add one or more identified Seals as responders to a case on the board.
!addresp	[Client Name or Case ID] [New Responders]	Add a new responder to a given case on the board.	Drilled Seals Only, must be run in a channel.
!adddisp	[Client Name or Case ID] [New Dispatchers]	Add a new dispatcher to a given case on the board.	Drilled Seals Only, must be run in a channel.
!remresp	[Client Name or Case ID] [Responders]	Remove a responder from a given case on the board.	Drilled Seals Only, must be run in a channel.
!remdisp	[Client Name or Case ID] [Dispatchers]	Remove a dispatcher from a given case on the board.	Drilled Seals Only, must be run in a channel.

Case Note Management

Command	Arguments	Use	Requirements
!listnotes	[Case ID]	List the case notes for the given case.	Drilled Seals Only, must be run in a channel.
!addnote	[Case ID] [New Note]	Adds a new line to the case notes.	Drilled Seals Only, must be run in a channel.
!editnote	[Case ID] [Note Index] [New Note Content]	Edit the specified case note.	Drilled Seals Only, must be run in a channel.
!delnote	[Case ID] [Note Index]	Delete the specified case note.	Drilled Seals Only, must be run in a channel.

Dispatcher Commands

Command	Arguments	Uses	Requirements
!mancase, !manualcase	[IRC Name] [Case Info]	Used to start a new Manual Seal Case by Dispatchers	Drillled Seals Only, and run in a channel.
!manfish, !manualfish	[IRC Name] [Case Info]	Used to start a new Manual Kingfisher Case by Dispatchers	Drillled Seals Only, and run in a channel.
!tsping, !wssping	[Case Info]	Used to ping the "Trained Seal" role in the Seal discord.	Drillled Seals Only, and run in a channel.
!forcejoin	[user] [channel name]	Force a user to join an allowed channel in IRC.	Drilled Seals Only, must be run in a channel.
!rrjoin	[user]	Forces a user to join #Repair-Requests	Drilled Seals Only, must be run in a channel.

[Case Info] means that any text after the command will be passed as the case information.

Abuse of tsping will result in heavy disciplinary action.

Utility Commands

Utility commands are useful tools in HalpyBOT, but don't have a specific task in normal repair workflows.

Command	Arguments	Uses	Requirements
!ping		Check to see if the bot is responding to commands
!dbping		Check to see the responsiveness of the database	Cyberseals Only.
!edsmping		Check to see the responsiveness of EDSM's API	Cyberseals Only.
!utc		Check for the current In Game Time and Date
!year		Check for the current In Game Year
!whois	[name]	Check the user information for registered name	Must be a registered user, and run in DMs with HalpyBOT.
!whoami		Check the user information on yourself	Must be a registered user, and run in DMs with HalpyBOT.
!say	[channel] [message]	Make HalpyBOT say something in a channel.	Cyberseals Only.
!serverstatus		Check the current FDEV-Provided Server Status
!cybersignal, !summontech, !calltech, !cybersig	[message]	Sends a notification to all Tech Staff to report an issue	Must be a registered user, and run in a channel.
!summonstaff, !callstaff, !opsig, !opsignal	[message]	Sends a notification to all non-technical staff to report abuse of systems or other rule issues	Must be a registered user, and run in a channel.
!joinchannel	[channel name]	Instruct HalpyBOT to join a new channel.	Cyberseals Only.
!partchannel	[channel name]	Instruct HalpyBOT to leave a channel.	Cyberseals Only.
!shorten	[URL]	Shortens a URL using the hullse.al shortlink host.	Drilled Seals Only.

Cybersig and Opsig are limited to once every 5 minutes. Abuse or spam of these commands will result in disciplinary action.

Drill Commands

Command	Arguments	Uses	Requirements
!drillcase	[cmdr], [platform], [system], [hull]	Manually create a new Seal drill case	Drilled Seals +, in a channel.
!drillcbcase	[cmdr], [platform], [system], [hull], [cansynth], [o2]	Manually create a new CB drillcase.	Drilled Seals +, in a channel.
!drillkfcase	[cmdr], [platform], [system], [planet], [coords], [type]	Manually create a new Kingfisher drill case	Drilled Seals +, in a channel.

Fact Management Commands

Command	Arguments	Uses	Requirements
!factinfo	[name-lang]	Get information about a fact	Admin or Cyberseal
!addfact	[fact-lang] [text]	Add a new fact to the database	Admin or Cyberseal
!deletefact	[fact-lang]	Delete a fact	Admin or Cyberseal
!allfacts, !factlist, !listfacts	<language>	List all facts by a given language (English by default)
!editfact, !updatefact	[fact-lang] [new text]	Edit an existing fact	Admin or Cyberseal
!ufi, !updatefactindex		Manually update the Fact listing cache	Cyberseals Only.

Common Facts

Below are some of the registered Facts in HalpyBOT.

Fact	Use
!bacon	A fun little link - who doesn't love Bacon!
!beacon, !bc	How to turn on a Wing Beacon
!cbinfo	To gather Code Black information from a manual case.
!cbmining	Information about how mining works for clients in Code Black cases.
!chatter	If Repair Requests has too much side conversation happening, to redirect Seals to better places.
!clientinbob	For use when a Case is in the Seal Bob, and the channel must shift to a rescue focus.
!clientinfo	To gather case information from a manual case.
!cmdlist	This page!
!drillpw	Paperwork link for Drill cases.
!escapeneutron	Information and guides on how to escape a Neutron Cone
!fuel	Redirect a Client to the Fuel Rats
!highg	Prepare a Client to take off from a High G planet.
!join	Provide a user information on how to join the Hull Seals
!kfbeacon, !srvbeacon	Request a Client turn on their Wing Beacon from their SRV
!nickserv	How to authenticate with NickServ
!paperwork, !pw, !clear, !ppwk	Send a Seal their paperwork link.
!pcfr	Request a Client add their Seals to their Friends List.
!pcfrcb	Instructions on how to add a Seal to your Friends List from the Main Menu
!prep	Get a Client ready for their Seal's arrival.
!psfr	Request a Client add their Seals to their Friends List.
!rebootrepair, !rr	Provide instructions on what a reboot and repair cycle is, and what it does
!securechannel	For when important Case info is being discussed in the Seal Bob, and other topics should wait until the case is over.
!stuck	To gather Kingfisher information from a manual case.
!synth	Instructions on how to synth a new life support refill
!team	Instructions on how to add a Seal to your Team (Odyssey)
!ticket	Quicklink to the support ticket creation page
!tos	A quicklink to our TOS. If this is used, a hammer is likely to follow.
!verify	Request a suspect Client provide an image or other information to help validate their repair request. If used, immediately inform a staff member.
!welcome	Welcome a Client and get them ready for a Dispatcher's arrival
!wing, !wr	Request a Client add their Seals to their wing.
!xbfr	Request a Client add their Seals to their Friends List.

You have to be a registered (+r) user in our IRC in order to use these facts.

HalpyBOT Command and Fact Listing

What is HalpyBOT?

Commands vs Facts

Case Board

HalpyBOT Command Listing

General Commands

Case Board Management

Case Detail Management

Case Responder Management

Case Note Management

Dispatcher Commands

Utility Commands

Drill Commands

Fact Management Commands

Common Facts

No Comments