Skip to content

Latest commit

 

History

History
111 lines (83 loc) · 4.59 KB

README.md

File metadata and controls

111 lines (83 loc) · 4.59 KB
Raw



Calypso Discord Bot

A multipurpose bot built with discord.js

Features • Installation • Set Up • Colors • License • Credits

Calypso is an open source, multipurpose Discord bot that is constantly growing. You can invite her to your Discord server using this link! Also, join the official Calypso Support Server for all questions, suggestions, and assistance!

If you liked or enjoyed this repository, feel free to leave a star ⭐ to help promote Calypso!

Features

  • Moderation commands with optional logging
  • Fun commands, including trivia
  • General/utility commands
  • Points system with leaderboards and a rotating winner
  • Cat & dog pics
  • Color system
  • Per server customization
  • And much more!

Installation

You can add Calypso to your server with this link! Alternatively, you can clone this repo and host the bot yourself.

git clone https://github.com/sabattle/CalypsoBot.git

After cloning, run an

npm install

to snag all of the dependencies. Of course, you need node installed. I also strongly recommend nodemon as it makes testing much easier.

Set Up

You have to create a config.json file in order to run the bot (you can use the example file provided as a base). Your file should look something like this:

{
  "token": "your_token_here",
  "ownerId": "your_ID_here",
  "apiKeys": {
    "catApi": "your_API_key_here",
    "googleApi": "your_API_key_here"
}

Visit the Discord developer portal to create an app and use the client token you are given for the token option. ownerId is your own Discord snowflake. To get keys for supported APIs, vist:

Once done, feel free to launch Calypso using the command node app.js or nodemon app.js. If on Linux, you can also kick off using the start.sh script. If you need additional help setting up, join the Calypso Support Server!

Colors

To have colors on your server, first create a bunch of empty roles at the bottom of your server's role heirarchy. The names of these roles must begin with the character #, for example, #Red or #Blue. Then change the color of that role to your desired hex, and that's it! Or, use the provided createcolor command to quickly and easily create new colors. After they are set up, the members of your server can then change their color by using Calypso's color commands! Credit to Threebow for the idea.

Alt Text

To-Do

Calypso is in a continuous state of development. New features/updates may come at any time. Some pending ideas are:

  • Stream alerts
  • Custom tag/reaction system

License

Released under the GNU GPL v3 license.

Credits

  • Sebastian Battle - Initial work - github
  • Kyle Glaws - github
  • CommradeFido#5286 - All art and graphics
  • Red Discord Bot - Initial trivia - github
  • Threebow - Ideas and tutorials - github