Staff Commands

Staff Access and Bot Identity

Registering

Members of the #Trivia staff team must first register with the bot to gain access to commands associated with their privilege level. To register, send an IRC Private Message to TriviaMaster in the following format: register username password. The bot will reply with a success message, and store the hostmask you're currently using to automatically identify you. Please note that registering with the bot does not automatically grant access to any privilege levels or commands defined below. Once you have registered, contact rb14060 to be granted the appropriate privilege levels.

Identifying

Assuming you use the same IRC nick, you're authenticated to Hummingbird, and your user class on PTP doesn't change, the bot will automatically recognize you based on the hostmask you were using during registration. However, if any part of your hostmask changes, including not being authenticated to Hummingbird, or if your user class changes, you will no longer be recognized. You can check if the bot recognizes you by sending the command whoami to TriviaMaster in a PM. The bot will either provide your username if it recognizes you, or will tell you you're not authenticated if not. If you're not recognized, send the command identify username password in PM. Then, send the command hostmask add to be automatically recognized by your current hostmask.

Privilege Levels

There are three privilege levels that may be granted to members of the staff team. You may be assigned more than one depending on your role, and assignment of one level does not automatically grant access to commands restricted to any other levels. In other words, you must hold the appropriate privilege level for the command you're trying to use. You can check your assigned privileges by sending the command capabilities to TriviaMaster in a PM. The bot will respond with any privilege levels you've been granted. The three privilege levels are as follows:

• Trivia Editors (TE): Members of the editing team who likely also have access to the staff Git. This privilege level grants access to commands that interface directly with the Git, such as creating Pull Requests or updating the question set data on the bot's server.

• Trivia Managers (TM): Grants access to some question set management commands, such as the ability to switch sets or play modes.

• Trivia Owners (TO): High level management privilege which is used for commands that are potentially dangerous or have the potential for abuse, such as direct points manipulation or modification/overwriting of the actual files used for live gameplay. Commands that are under active development will usually start in this privilege level, as not all safety checks may be implemented in the early stages of command development.

Command List

Question Set Management

• -qset swap "name" (TM): NOT YET IMPLEMENTED. Swaps the currently active question set with the one given in the command. Saves the current question positions for the old set into the question set directory, then loads the new set's processed question files, settings file, and question positions.

• -qset rebuild "name" (TO): NOT YET IMPLEMENTED. Deletes all files in the orig subfolder of the question set, takes the processed (split) question files and combines them into a single large file, removes blank lines, then deletes the split files. Due to the way BogusTrivia is written, if questions are deleted from the set, the entire set must be erased and reloaded. This command helps to facilitate that process.

• -qset swaporig "name" (TO): NOT YET IMPLEMENTED. Similar to the swap command except it uses the unprocessed question files in the orig subfolder of the question set. Saves the old set's current positions but does not restore positions for the new set, as it's assumed the set is being reloaded. Used when a set needs to be reprocessed by the bot, usually due to either new questions being added, or questions were deleted out of the set. Often used after the rebuild command as the next step in reloading the set.

• -qset save (TO): NOT YET IMPLEMENTED. Copies the processed question files from the bot into the question set directory. Often used after the swaporig command to update the files in Git so the report commands link to the proper question.

• -qset sync (TE): NOT YET IMPLEMENTED. Synchronizes the question set directory with the main branch in Git. Used primarily when Pull Requests have been approved and updated question set files are available.

• -qset update (TE): NOT YET IMPLEMENTED. Overwrites the bot's live, processed question files with files from the question set directory without resetting gameplay position. Useful when questions in the current set have been edited but none have been deleted.

• -qset reset (optionally, "name") (TM): NOT YET IMPLEMENTED. Resets the question position back to 0 in the given set, or in the current set if no name is specified.

Points Management

• -points add "nick" "points" (optionally, "reason") (TO): Gives the specified number of points to the given nick, and increases the correct question counter by 1. Reason is optional but is logged if provided. Useful if a player lost out on points due to various reasons, such as the answer being misspelled or bot lag.

• -points remove "nick" "points" (optionally, "reason") (TO): Same as the points add command, but removes the points and decreases the correct question counter instead.

Bot Management

• -resetbot (TO): Advances the bot forward one question, then restarts the bot. Used when the bot hangs due to a question file or other script error.