Skip to content

Latest commit

 

History

History
115 lines (102 loc) · 4.85 KB

utility.md

File metadata and controls

115 lines (102 loc) · 4.85 KB
Raw

Utility Plugin

The utility plugin provides a number of useful and fun commands

Commands

Name Description Default Level Usage
!cat / kitty / kitteh Returns a random image of a cat Default !cat OR !kitteh OR !kitty
!doggo / pupper / dig / doggy Returns a random image of a dog Default !doggo
!bunny Returns a random image of a bunny Default !bunny OR !bunbun
!floof Returns a random image of a cat, dog or bunny Default !floof
!emoji {emoji} Returns information on the given emoji Default !emoji :smiley:
!info {user} Returns information on the given user Default !info 232921983317180416 OR !info @rowboat#0001
!jumbo {emojis} Returns 128x128px images of the given emoji Default !jumbo :cat: :dog: :rabbit:
!random coin Flips a coin and returns the result Default !random coin
!random number [end number] [start number] Returns a random number from 0-10 or in a range if specified Default !random number OR !random number 50 20
!r add {duration} {content} OR !remind {duration} {content} Adds a reminder. Bot will mention the user after the specified duration with the given message Default !r add 24h update announcements OR !remind 24h update announcements
!r clear Clears all of the user's reminders Default !r clear
!search {query} Searches for usernames that match given query. If the result is the only object returned it will turn into info automatically Default !search b1nzy
!seen {user} Returns the timestamp of when the bot last saw a message from given user Default !seen 232921983317180416 OR !seen @rowboat#0001
!server [guild] Returns information on the current server or the Server ID if given Default !server OR !server 290923757399310337
!avatar {user} Displays user's avater Default !avatar b1nzy
!announce {channel} {message} Announce message to channel. Channel must have configuration in the utility plugin configuration Admin !announce #community-news it's a me, mario!
!log warning/debug/info Set logging level for the bot GA !log warning

Configuration Options

Option Description Type Default
announce Channels that can be announced into dict empty
auto_clean Channels that can be autocleaned dict empty
reaction_roles MessageID of message to attach reactions with roles against dict empty

Announce Configuration Options

Option Description Type Default
webhook_id ID of webhook to post to str empty
webhook_color Color of webhook embed int 0x000000
webhook_name Username for webhook str Guild Name
webhook_avatar Avatar URL for webhook "user" str None

Autoclean Configuration Options

Option Description Type Default
timeout Time to wait before deleting (seconds) int None

Reaction Roles Configuration Options

Option Description Type Default
emoji

Dict containing the emoji id and a list of role ids. (It is also possible to include an inbuilt emoji name in place of the emoji id)

Also note that if one of the roles is set to either of below it will force that reaction to only allow join or leave of such roles:

  • join_only
  • leave_only
dict empty
## Configuration Example 
utilities:
  announce:
    32490583480348083409:
      webhook_id: 304958304934209534
      webhook_color: 0xffffff
      webhook_name: Heimdallr
      webhook_avatar: https://i.imgur.com/3cOLFsb.png
  auto_clean:
    32490583480348083409:
      timeout: 3600
  reaction_roles:
      540540948065550348:
        emoji:
          506810410650042389:
            - 540558688960774165
          506810368740556802:
            - 540558657243447306
          510489235267125260: 
            - 540565706190749700
            - 540565747840188448
          zero:
            - 238947234897234897
            - 238947234897234487
          one:
            - 238947234897234845
          regional_indicator_j:
            - join_only
            - 1328971238971239871
          regional_indicator_l:
            - leave_only
            - 1328971238971239871