Skip to content

Latest commit

 

History

History
47 lines (31 loc) · 2.29 KB

README.md

File metadata and controls

47 lines (31 loc) · 2.29 KB

🐀 rat facts

Image of rat emoji

Rat facts is a Discord bot that delivers rat-based content.

GIF showing off the rat facts bot in action

Features

  • Gives random facts about rats (over 100!)
  • Shows off pictures of rats
  • Tells jokes about rats
  • Consults the O-rat-cle to predict your future
  • Take a quiz on your rat knowledge
  • Become labeled a rat yourself
  • Describes the lore beyond a great rat civil war

Available Commands:

All commands are evoked as slash commands! Type / and select a command from below:

  • /fact
  • /pic
  • /joke
  • /8ball {question}
  • /quiz
  • /role
  • /lore
  • /help
  • /misc

Adding rat facts to a server

Click here to invite rat facts to your server

Find us in the in-app Discord App Directory!

Check it out on Top.gg!

Technical Details

Rat facts is built as a Node.js project. Additionally, it is written in TypeScript alongside other developer conveniences like ESLint and Prettier The bot relies heavily on the Discord.js module to make working with Discord's API much easier. Much of the information used for the various commands are stored in local JSON files, making them easy to expand with additional facts, jokes, or photos. The bot is hosted on a BisectHosting instance using their Bot Hosting service.

Expanding the Bot

If you would like to develop on the bot yourself, simply clone the repo and provide your own credentials. The main file (rat.js) reads from a .env file for a BOT_TOKEN. This will match the bot token generated by Discord when you register the app via the Discord Developer Portal. Fill in your own token and run npm start to start the bot NOTE: your new bot must be added to your server; the invite link can be generated within the Discord Developer Portal.