Skip to content

Latest commit

 

History

History
79 lines (54 loc) · 3.4 KB

README.md

File metadata and controls

79 lines (54 loc) · 3.4 KB
Raw

KittisaurusBot

A Discord.js bot that allows users to have fun with pictures and quotes of the 10 Kittisaurus cats + more!

How do I use it?

There are two ways by which you can use KittisaurusBot:

  1. This is the most simple (and recommended for regular users) way. You can invite KittisaurusBot to your server or join an existing one that features it!
  2. You can set up the bot to work on your own Discord Bot application. (Only recommended if you are making changes to the bot!)

Setting up the bot

  1. Make sure you have your Discord Application created with an initialized bot.
  2. Install Node.js version 16.6 or higher on your desired host (if you don't have it already).
  3. Clone (or download) the repository.
  4. Create a .env file, paste and fill in the following:
DISCORD_TOKEN={your-bot's-token}
CLIENT_ID={your-bot's-client-id}
  1. Run npm install to install the needed libraries for the bot.
  2. Run node deploy-commands.js to deploy the bot's commands.
  3. Execute npm start (or node bot.js) to run the bot.

After you make changes to the bot, terminate the running bot process (Ctrl+C) and start the bot again (npm start or node bot.js).

If you make changes to the bot's commands, run node deploy-commands.js again to register the changes. (It may take a few minutes for the commands to be usable again.)

Commands

A list of all currently supported commands by KittisaurusBot.

/help

  • Shows an embed featuring all bot commands (+ contribution and feedback information).

/{cat}

  • Shows a picture of a specified Kittisaurus cat with a quote.

/cookforkitties

  • Cooks a meal for the kitties to enjoy.

/feedkitties {meal}

  • Feeds the kitties a certain meal (from the ones available for cooking).

/playwithkitties

  • Shows a picture of a playing Kittisaurus cat with a quote.

/sleepykitties

  • Shows a picture of a sleepy Kittisaurus cat with a quote.

/snackstealcheck

  • Allows you to check out if the Kitty Pirates are succeeding at stealing snacks!

KittisaurusBot Help Embed

Credits

Images:

  • This bot uses some images and GIFs from Google Images. Links to them are available inside of the respective command's file (inside of the commands folder).
  • Imgur.com is used to host the other part of the images and GIFs (for now).

Code:

  • Scratch for Discord was used for building the bot before it was worked on with code. (Many changes were made after that)
  • discord-greeter-bot was used for a starter template when the project started to be worked on with code.
  • StackOverflow.com is used to help in some parts of the code.
  • Discord.js Guide is used to help building the main aspects of the bot.

Contribution

Any contributions to the bot (including issues, feature requests, pull requests or others) are always very appreciated and welcome!

Feedback

If you encounter any issues with the bot, have any suggestions or questions, you can post an issue here on GitHub (if it doesn't exist already) or DM me on Discord at Vankata453#4832!