X-Git-Url: https://code.communitydata.science/coldcallbot-discord.git/blobdiff_plain/677315cd95ce1f656b790e616be45f7dc56a2a21..89c5369ad9bbefda1053caa99b9dca4e06f18f28:/README diff --git a/README b/README index da52a4d..733a2e8 100644 --- a/README +++ b/README @@ -1,14 +1,27 @@ Setting up the Discord Bot ====================================== -I run the Discord boy from my laptop. It requires the discord Python +I run the Discord bot from my laptop. It requires the discord Python module available in PyPi and installable like: $ pip3 install discord -I don't have details on how I set up my own Discord bot and/or invited -it to my server but I hope you'll add to this file as you do this and -figure out what needs to happen. +Setting up the Bot +===================================== + +The documentation for the `discord` python package +(https://discordpy.readthedocs.io/en/latest/discord.html) does a good +job explaining how to set up a Discord bot with your server. Follow +the steps there, with one important exception: + +1. On the "Bot" tab in the discord application configuration page you +need to enable both "Privileged Gateway Intents." This allows the bot +to see who is present and active in the channel. + +Finally, you need to copy your bot'ss Token (also found on the "Bot" tab) +into coldcallbot.py. Pass it as the argument to `ccb.run()`. + + Using the Cold Call Bot ====================================== @@ -31,7 +44,7 @@ Daily Process You need to start the bot from the laptop each day. I do that by: - $ ./coldcallboy.py + $ ./coldcallbot.py The bot will run in the terminal, print out data as it works including detailed weights as it goes, and it will record data into files in the