Secretary_Helen usage guide
Hey All. If you're reading this, this applies to my chatbot Secretary_Helen (ydal.dna.dael.nori|stellubxis#ydal.dna.dael.nori|stellubxis).
You can PM her any of these commands, and also use them directly in any channel she's in.
If you find any bugs/unexpected responses, please let me know immediately.
-DrMagnus
Magnus, there's this thing called Nickgroups, and I'm so confused.
Of course you are. Okay, this is what you do:
STEP 1. Change to the nick you want to be the…idk, "main" one. Who cares. e.g. "/nick DrMagnus"
STEP 2. Instruct hel-bel to store your nick group. e.g. ".addnick MobileMagnus"
STEP 3. Add any further nicks you wish, by switching to one of your already grouped nicks (or just the one you're on), and doing .addnick again. e.g. ".addnick drmagnustein"
STEP 4 (Optional). Set your timezone and pronouns. You can view how to do this in the below table under .setTimezone and .setPronouns respectively.
None of this is case sensitive. Reach out if you have any questions.
Regular Chat Commands
The brackets in the example are just separators. Do not include the square brackets when using commands.
| Command in Chat | Permissions | Function | Example |
|---|---|---|---|
| .def,.definition | Anyone | Searches dictionary.com for the definition of your word. | .def [word] |
| .exit | Admins and Above | Forces helen to Exit, shutting down her Java process. If you do this, contact DrMagnus or ChaoSera immediately to restart Helen. Also, don't. | .exit |
| .g,.google | Anyone | Searches google for the specified term. | .g [term] |
| .gis | Anyone | Searches Google Images for the specified term | .gis [terms] |
| .helen,.helenHelp | Anyone | Gets this help page. | .helen/.helenhelp |
| .help | Anyone | Displays this help page. | .help |
| .hlt | Anyone | Displays the time helen thinks it is. | .hlt |
| .hugHelen,.helenhug,.hugsplox | Anyone | Hugs the bot. She may or may not respond positively. | .hugHelen |
| .hugme | Anyone | Allows you to set a hug message if magnus likes you and added you to the list | .hugme [message] |
| .join | Ops and Above | Tells helen to join the specified channel | .join [channel] |
| .lc,.l | Anyone | Displays the last three articles written on the wiki. | .lc |
| .leave | Ops and Above | Tells helen to leave the specified channel | .leave [channel] |
| .ch,.choose | Anyone | Choose between a list of comma separated values. The bot isn't responsible for your bad decisions. | .ch [option1, option2,…option n] |
| .reload | Admins and Above | Helen reloads all six chambers. Pew pew. | .reload |
| .roll | Anyone | Rolls a dice of the specified number, and the specified size. | .roll [#dDiceSize] |
| .seen | Anyone | Displays the last time the specified user was seen. With the -f flag will display the first time that the user was seen. | .seen [user] [channel] |
| .setTimezone | Anyone | Set's your timezone. Please format as GMT[+ or -][hours as 24 hours]. An example for EST would be GMT-05:00 | .setTimezone GMT-05:00 |
| .shoot | Admins and Above | Shoots a user. Probably not enabled for the channel you're in. | .shoot [user] |
| .sm | Anyone | Chooses from a list of results that helen returned. Is specific to the user. | .sm [number] |
| .tell | Anyone | Sends a tell to a user. The next time Helen sees any of their grouped nicks, it will deliver the message. | .tell [user] [message up to 255 characters] |
| .masstell | Anyone | Sends a tell to multiple users. The next time Helen sees any of their grouped nicks, it will deliver the message. DO NOT USE COMMAS. YOU HAVE BEEN WARNED | .masstell user1 user2 user3 | message |
| .timezone | Anyone | Retrieves a user's timezone (if they've configured it) and tells you the current time in that timezone. | .timezone [user] |
| .unload | Admins and Above | Shoots a user *a lot*. Helen will have to reload after this. | .unload [user] |
| .w,.wiki,.wikipedia | Anyone | Searches Wikipedia for the specified term. | .w [terms] |
| .y,.yt,.youtube | Anyone | Searches youtube for the specified term. | .y [terms] |
| .HelenBot | Anyone | Checks the status of Helenbot and returns the version information | .helenbot |
Nick Commands
| Command in Chat | Permissions | Function | Example |
|---|---|---|---|
| .addNick | Anyone | Adds or establishes a nick-group to receive tells. Tells sent to any nicks in a group will be delivered to any nick in that group that Helen sees. | .addNick [Nick to be added]; .addNick {empty} will establish your nick group with the current nick as the first entry |
| .deleteAllNicks | Anyone | Deletes all your nicks from a nick group | .deleteallnicks |
| .deleteNick | Anyone | Deletes a nick from your nick grouop | .deleteNick [nick to be deleted] |
| .deleteNicksAdmin | Admins and Above | Admins can specify a user, and will delete all their nicks from their nick group | .deletenicksadmin [user who's nicks are to be delete] |
Admin Stuff
| Command in Chat | Permissions | Function | Example |
|---|---|---|---|
| .mode | Hops and Above | Checks the global response mode. | .modetoggle |
| .modeToggle | Ops and Above | Flips the global response flag. When set to "false" Helen will not respond to any commands | .modetoggle |
| .o5 | Ops and Above | looks up a users 05 record | .o5 username |
| .clearCache,.clear | Admins and Above | Forces helen to reload several things, including her back-end query system. Please be careful with this, and inform Magnus if you feel you need to use this. | .clearCache/.clear |
| .setProperty | Admins and Above | Sets a property within the bot. | .setProperty [propertyname] [public/private as a t or f respectively] |
| .rem | Hops and Above | Sets a remark for a given keyword. Existing values are overwritten! | .rem exampleuser Flooded in #site19. |
| .addCommand | Admins and Above | Adds a simple retrieval dot command. If the command already exists, it will overwrite the message. Do NOT include a . in the keyword | .addCommand keyword|text |
| .listcommands | Admins and Above | Lists out the simple retreival dot commands. | .listcommands |
| .deleteCommand | Admins and Above | Deletes a simple retrieval command. | .deletecommand keyword |
Ban Specific Syntax
Adding a ban
You must specify some things when adding a ban. Flags are separated from their values by a single space. Different flags are separated by the | character. See examples, and ask if you are unsure.| Flag | Function | Required? |
|---|---|---|
| -u | User: Specifies the user to ban. Can be separated by COMMAS only. | No, but you should have either usernames or hostmasks. |
| -h | Hostmask: Specifies the hostmasks to ban. Can be separated by COMMAS only. | No, but you should have either usernames or hostmasks. |
| -c | Channel: Channel to ban them from (#site19 vs #site17). Keep in mind, Site19 bans carry to critters and workshop. | Yes. |
| -r | Reason: Why you're banning them | Yes. |
| -t | Time: When this ban ends. Specified as "YYYY-MM-DD;HH:MM:SS". | No but you need either T or D. |
| -d | Duration: A length of time from today to ban for (d:day,w:week,m:month,y:year,p:perma) | No, but you need either T or D. |
| -o | O5 Thread: Specifies the user's o5 thread record. Separate multiple threads with a SPACE please. | No. |
Examples:
- .addBan -u user1,user2| -c #site19| -d 1w| -r Slurs
- .addBan -h pen.and.sword.in.accord| -c #site19| -d 1w| -r Magnus is the dumbest person ever.
- .addBan -u vcas| -c #site17| -t 2020-03-14;12:00:00| -r Month to cool down| -o http://05command.wikidot.com/forum/t-12995756/vcas
After helen responds and you confirm the details are correct, please use the command .confirmAdd to enact the ban or .cancel to remove the pending change
More Info on Hostmasks
In general, banning the hostname is sufficient. For example, banning a user with a hostmask of 552.552.D2C.B1A-PCS|egnuoleht#552.552.D2C.B1A-PCS|egnuoleht would require specifying -h SCP-A1B.C2D.255.255. IRCCloud is a special case. If a user has a hostmask of moc.duolccri.daetspmah.oof-PCS|546231diu#moc.duolccri.daetspmah.oof-PCS|546231diu, specify -h uid132645@*. This is necessary because multiple IRCCloud users may connect from the same IRCCloud host, and individual users may move to a different host under some circumstances.
Updating a ban
Ban updates must be done by ban id. To find the ban id, you must find the ban first. Once you do, it must be specified with the -i flag.
.findban works with either username or hostmask, and will find all bans for the user matching them.
- .findban -u username
- .findban -h hostmask
This will return an INTEGER at the front of Helen's return. That's the ban id.
From there, you can update a ban with any NEW usernames, hostmasks, overwrite the reason, thread, or duration fields. All the flags are the same as above.
- .updateban -i xxxx|-h hostname, hostname, hostname|-o http://05threadgoeshere.com
Deleting a Ban
Ban deletions must be done by ban id. To find the ban id, you must find the ban first. Once you do, you delete a ban with the following:
.deleteban <banid>
Helen will ask you to confirm the ban
Respond with .confirmdelete or .canceldelete to confirm the removal.