Aesthetics Bot Documentation

Table of Contents

1 About

Build Status

Documentation for utmmcss discord bot.

2 Configuration

  • Copy docs/config.json.sample to config.json

2.1 Property Explanation

  • token
    • Your discord server token
    • Used to tell the bot what server to connect to
  • prefix
    • The prefix used before most bot commands
    • Default is !. We use this for the command documentation
  • COBALT_key
    • Your cobalt API token
    • Used to connect to cobalt for information about UofT
  • kitsu_id and kitsu_secret
    • Your kitsu API ID and Secret (found here)
    • Used to connect to kitsu for anime searching
  • anime_channels
    • A list of channel names which are allowed to have anime lookups
    • This allows both the {{}} and [[]] notation.
  • school_channels
    • A list of channel names which are allowed to have UofT lookups
  • crypto_channels
    • A list of channel names which are allowed to have crypto value lookups
  • valid_roles
    • A list of role names which uses are allowed to self assign
  • mongo_connection
    • The connection string to your mongodb.
    • This is used for karma as well as user statistics.
    • It is highly recommended that you secure your database.
  • fortnite_tracker_apikey

3 Commands

3.1 Roles

  • !giveroles [Role Name]
  • Assigns the user a role if the role is present in the Valid Roles config option

3.2 Karma

  • @username ++ or @username –
  • Gives (or takes) a karma point to the username specified.
  • Giving karma has a 1 hour cooldown, taking is doubled.

3.3 Anime

  • {{Search Term}}
  • Will search kitsu for the specified anime name and return the result
  • [[Search Term]]
  • Will perform an interactive search and prompt you to select a result. It will then replace the results with your selection.
  • Commands are only valid in channels specified by the Anime Channels config option
  • The bot does not filter any NSFW results which may appear.

3.4 UofT

  • [Search Term]
  • Will automatically search any term which appears to be a course code
  • Commands are only valid in channels specified by the School Channels config option

3.5 Cryptocurrencies

  • !val [Token]
  • Seaches for the current value and market changes of the token on Coin Market Cap.

3.6 Fortnite Stats

  • !fortnite [epic games name] <platform:optional pc, xbl or psn>
  • Searches for that users fortnite statistics and displays an embed detailing information like KDA, win rate and win percentage.