How do I use BoilerSniper?
The simplest way to use BoilerSniper is to join the BoilerSniper Discord server, which is already designed around the BoilerSniper bot and is ready for anyone to track any course section(s) of their liking.
Here's a Quick Start Guide on how to use BoilerSniper within the main Discord server:
Prerequisite: You must be added to the whitelist to use the bot. To request for a whitelist, go to #whitelist-request and send "wHiTeLiSt reQuesT!-@ @doghut" EXACTLY. Failure to send this exact message (case and character sensitive) will nullify your request.
Go to the Scheduling Assistant (UniTime).
Go to the course and find the section of interest.
Locate the header that says CRN-SectionID.
Identify the CRN (course reference number) for the section. This is typically a 5-digit number that serves as a unique identifier for the section. In UniTime, the CRN is below the CRN-SectionID header and is to the left of the dash. For instance, if you see something below the CRN-SectionID header that looks like 13868-002, the CRN here is 13868.
Use /add [CRN you just found] [name of the section for your own reference] to begin tracking the section. You will be pinged when an opening is found. Note: you will be pinged repeatedly until you run /pause or /remove, both of which will be explained further below. This system is (1) good for alerting you of something really important (at least I'd assume this is important to you) and (2) an easier system to implement on my end in general.
Use /list to see tracked sections. As soon as you begin tracking a section, I recommend running /list to locate your specific section and identify the number to the very left of said section. This is your index number for the specific section you're actively tracking.
To pause tracking for a section (probably because you no longer want to get spam pinged), use /pause [the index that you found from /list].
To resume tracking for a paused section, run /resume [the index that you found from /list].
To remove your tracked section from the system all-together, run /remove [the index that you found from /list].
You may run /help at any time for a concise recap of everything explained here.
Note: Each individual user is currently limited to tracking 2 sections max (simultaneously).
Want BoilerSniper in your own server?
Joining the main public Discord server remains the most convenient way to use BoilerSniper. However, having BoilerSniper in your own server is nice as you don't share the tracking list and the alerts chat with anyone else you don't want to. Unlike the main public Discord server, though, having BoilerSniper in your own server may require a bit of configuration depending on what you intend to do.
Add BoilerSniper to your Discord server by clicking here. Ensure that BoilerSniper has the administrator permission, which is a requirement for the bot to function properly.
Send a DM to me (doghut) on Discord and request to get authorization for BoilerSniper on your own Discord server. You can easily find my account in the main public Discord server, where you can then navigate to my profile and send me a message. Explanation: Authorization is necessary as to prevent abuse of the bot.
Upon receiving authorization, you agree to not abuse the bot by, for instance, adding a bunch of alts to your own server and whitelisting all of them to evade the 2 sections max per user tracking limit. Abusing the bot in a likewise manner will result in your server's authorization being revoked. You are, however, welcome to add other users (such as friends) to the whitelist. Although there's no specific limit, I ask that you please keep the number of whitelisted users in your server to a minimum, which is crucial for the functionality of BoilerSniper. Note: By adding BoilerSniper to your server, you consent to server audits when suspicious activity is spotted.
With BoilerSniper on your server, you will have access to BoilerSniper's admin commands, which can be viewed by running /adminhelp. First, type /setchat within whichever text channel you wish to have BoilerSniper send alerts in. By default, users with administrator permissions (such as yourself, presumably) can use BoilerSniper. However, regular users cannot unless they've been added to the whitelist. Use /whitelist add to add users to the whitelist, /whitelist remove to remove users from the whitelist, and /whitelist view to see who's on the whitelist.
Congratulations! BoilerSniper is fully ready to use on your Discord server.