Shicka

Bot for the official Super Bear Adventure Discord server

Configuring the bot

$ export SHICKA_DISCORD_TOKEN=<your-discord-token-here>
$ export SHICKA_OUTFIT_GENERATOR_SALT=<your-outfit-generator-salt-here>
$ export SHICKA_ROADMAP_INTENT_CHANNEL=<your-roadmap-intent-channel-here>
$ export SHICKA_TRACKER_INTENT_CHANNEL=<your-tracker-intent-channel-here>
$ export SHICKA_APPLICATION_DEFAULT_CHANNEL=<your-application-default-channel-here>
$ export SHICKA_APPLICATION_APPLYING_ROLE=<your-application-applying-role-here>
$ export SHICKA_APPROVAL_DEFAULT_CHANNEL=<your-approval-default-channel-here>
$ export SHICKA_ARRIVAL_DEFAULT_CHANNEL=<your-arrival-default-channel-here>
$ export SHICKA_DEPARTURE_DEFAULT_CHANNEL=<your-departure-default-channel-here>
$ export SHICKA_PATCHING_DEFAULT_CHANNEL=<your-patching-default-channel-here>
$ export SHICKA_POSTING_DEFAULT_CHANNEL=<your-posting-default-channel-here>
$ export SHICKA_RECORD_DEFAULT_CHANNEL=<your-record-default-channel-here>
$ export SHICKA_REFUSAL_DEFAULT_CHANNEL=<your-refusal-default-channel-here>
$ export SHICKA_VERIFICATION_DEFAULT_CHANNEL=<your-verification-default-channel-here>
$ export SHICKA_VERIFICATION_VERIFIED_ROLE=<your-verfication-verified-role-here>
$ export SHICKA_LINK_DEFAULT_ALERT_ACTION_CHANNEL=<your-link-default-alert-action-channel-here>
$ export SHICKA_LINK_DEFAULT_EXEMPT_CHANNELS=<your-link-default-exempt-channels-here>
$ export SHICKA_LINK_DEFAULT_EXEMPT_ROLES=<your-link-default-exempt-roles-here>
$ export SHICKA_LINK_REACTION_EMOJI=<your-link-reaction-emoji-here>
$ export SHICKA_LINK_OVERRIDE_RULES_CHANNEL=<your-link-override-rules-channel-here>
$ export SHICKA_RULE7_DEFAULT_ALERT_ACTION_CHANNEL=<your-rule7-default-alert-action-channel-here>
$ export SHICKA_RULE7_DEFAULT_EXEMPT_CHANNELS=<your-rule7-default-exempt-channels-here>
$ export SHICKA_RULE7_DEFAULT_EXEMPT_ROLES=<your-rule7-default-exempt-roles-here>
$ export SHICKA_RULE7_REACTION_EMOJI=<your-rule7-reaction-emoji-here>
$ export SHICKA_RULE7_OVERRIDE_RULES_CHANNEL=<your-rule7-override-rules-channel-here>

Linting the bot

$ npm run lint

Building the bot

$ npm run build

Starting the bot

$ npm start

Features

Commands

• about gives the link to this repository on github.com

• apply makes the member enter the waiting room (only available to administrator members by default)

• approve is a shortcut for gate approve <channel> <message> (only available to administrator members by default)

• bear <bear> gives the gold time, the location, and the outfits of the given bear

• chat post <channel> <content> sends the given content in the given channel (only available to administrator members by default)

• chat patch <channel> <message> <content> edits the given message with the given content in the given channel (only available to administrator members by default)

• chat attach <channel> <message> <position> <attachment> adds at the given position the given attachment to the given message in the given channel (only available to administrator members by default)

• chat detach <channel> <message> <position> removes at the given position the attachment from the given message in the given channel (only available to administrator members by default)

• count gives the number of members of the guild

• emoji <base> <style>{6} draws the given base emoji with the given styles (only available to administrator members by default)

• gate approve <channel> <message> approves the author of the given message (only available to administrator members by default)

• gate refuse <channel> <message> refuses the author of the given message (only available to administrator members by default)

• help gives the feature list of this bot

• help <feature> gives the description of the given feature of this bot

• leaderboard gives the links to the speedrun leaderboards of the game on www.speedrun.com

• mission gives the schedule of the next three missions in the shop

• mission <mission> gives the schedule of at least the next two occurences of the given mission in the shop

• outfit gives the schedule of the next five sets of outfits in the shop

• outfit <outfit> gives the schedule of at least the next two occurrences of the given outfit in the shop

• patch <content> is a shortcut for chat patch <channel> <message> <content> (only available to administrator members by default)

• raw <type> <identifier> gives the datum of the given type with the given identifier

• refuse is a shortcut for gate refuse <channel> <message> (only available to administrator members by default)

• roadmap gives the link to the todo list of the game on trello.com

• soundtrack gives the links to the music pieces of the game on www.youtube.com

• store gives the links to the online stores of the game on superbearadventure.myspreadshop.net and superbearadventure.myspreadshop.com

• tracker gives the links to the issue trackers of the game on github.com and trello.com

• trailer gives the links to the trailers of the game on www.youtube.com

• update gives the links to the latest updates of the game on play.google.com and apps.apple.com

• verify makes the member exit the waiting room (only available to administrator members by default)

Hooks

• application posts the latest member application in the server in the given channel (set to $SHICKA_APPLICATION_DEFAULT_CHANNEL by default)

• approval posts the latest member approval in the server in the given channel (set to $SHICKA_APPROVAL_DEFAULT_CHANNEL by default) and sends a direct message

• arrival posts the latest member arrival to the server in the given channel (set to $SHICKA_ARRIVAL_DEFAULT_CHANNEL by default)

• departure posts the latest member departure from the server in the given channel (set to $SHICKA_DEPARTURE_DEFAULT_CHANNEL by default)

• patching posts the latest message patch on the server in the given channel (set to $SHICKA_PATCHING_DEFAULT_CHANNEL by default)

• posting posts the latest message post on the server in the given channel (set to $SHICKA_POSTING_DEFAULT_CHANNEL by default)

• record posts the latest world records of the game on www.speedrun.com in the given channel (set to $SHICKA_RECORD_DEFAULT_CHANNEL by default)

• refusal posts the latest member refusal in the server in the given channel (set to $SHICKA_REFUSAL_DEFAULT_CHANNEL by default) and sends a direct message

• verification posts the latest member verification in the server in the given channel (set to $SHICKA_VERIFICATION_DEFAULT_CHANNEL by default)

Rules

• link flags messages which contain a hyperlink as such in the given channel (set to $SHICKA_LINK_DEFAULT_ALERT_ACTION_CHANNEL by default) except when posted in any of the given exempted channels (set to $SHICKA_LINK_DEFAULT_EXEMPT_CHANNELS by default), when posted by non-administrator members having any of the given exempted roles (set to $SHICKA_LINK_DEFAULT_EXEMPT_ROLES by default) or when posted by administrator members

• rule7 flags messages which violate the rule 7 as such in the given channel (set to $SHICKA_RULE7_DEFAULT_ALERT_ACTION_CHANNEL by default) except when posted in any of the given exempted channels (set to $SHICKA_RULE7_DEFAULT_EXEMPT_CHANNELS by default), when posted by non-administrator members having any of the given exempted roles (set to $SHICKA_RULE7_DEFAULT_EXEMPT_ROLES by default) or when posted by administrator members