Skip to content

blobfysh/Secret-Santa-Bot

Repository files navigation

Secret-Santa-Bot

A Secret Santa bot for Discord!

Has features such as: easily starting a Secret Santa that users can join by reacting, creating a wishlist that your Secret Santa can see, and anonymously message your gifter/giftee

All data is stored in MySQL so no information is lost when the bot is restarted.

Commands

Name Description Usage
help View all the command, you can also specify a command to get more information. s!help [command]
create Create a new Secret Santa for everyone to join. s!create
start Assigns everyone a random partner (use this after you've created). s!start
setwishlist Edit your gift preferences. s!setwishlist <preferences here>
partnerinfo View your partners gift preferences. s!partnerinfo
participants Show a list of who's participating in your Secret Santa. s!participants
message Message your secret gifter or giftee, the bot will hide your name. s!message <gifter/giftee> <message to send>
cancel Cancels your Secret Santa. s!cancel
info View information about the bot like memory usage, server count. s!info

Self-host Instructions

Downloads:

Node.js (12.x or higher)

MySQL

  1. Clone the repository
  2. Rename config_example.json to config.json and add your own token to botToken (You can register a new Discord bot at: https://discordapp.com/developers/applications/)
  3. Create a new MySQL database with the same database name you have in config.json (Default is secret_santa)
  4. Run command prompt in the folder and execute the following:
npm install

After that the bot should be ready! Now just start it:

node app.js

IMPORTANT NOTE: This bot requires the Server Members intent which you will have to enable on your bot's application page.

About

A Secret Santa bot for Discord!

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published