Skip to content

README.md

Latest commit

 

History

History
23 lines (15 loc) · 1.8 KB

README.md

File metadata and controls

23 lines (15 loc) · 1.8 KB

#SantaBot

A Discord bot to organize secret santa gift exchanges using the discord.py Python library

##Instructions:

###Installation and Dependencies:

To add this bot to your Discord server, first ensure you have Python version 3.5 or later installed, along with the discord.py library and the configobj library. The asyncio, logging, os.path, and random libraries are also required, but they should be included in most Python installations by default.

Once all of the dependencies are installed, create a Discord bot token following the instructions here. Then, open the santa-bot.py file with your favorite plaintext editor, and replace the word 'token' in the last line that reads client.run('token') with the token you have generated, keeping the single quotes. The santa-bot.py file can now be excecuted, and the bot should function as normal.

###Bot Commands:

  • $$join adds you to the list of secret santa participants.
  • $$setaddress saves your mailing address for gifts to be sent to.
  • $$setprefs saves your gift preferences so your secret santa will know what kind of things you would like to receive. Keep in mind that your exact input is sent to your secret santa as is.
  • $$listparticipants makes the bot list all of the people currently participating in the secret santa exchange.
  • $$totalparticipants makes the bot give the number of people currently participating in the secret santa exchange
  • *$$start to have the bot assign each participant a partner
  • *$$shutdown to make the bot self-terminate

all commands marked with a * can only be run by a server admin.