diff --git a/README.md b/README.md index 6ded832..7b598dd 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,21 @@ # discord.py-welcome-bot - +__ A simple bot that can be used to welcome new users to a discord server, send them a custom private message, send a welcome message to a specific channel, and adding them to a role. A video explaining how to set up everything except adding the user to a role can be found [here](https://youtu.be/N0NP7BfUFxA). **Update November 2019** - Now set up as a docker container to ensure full compatibility as I will not be maintaining this. Specific versions of Python and Discord.py are required for this script to work.\ **Update November 2020** - Added basic install instructions for home computers and generic Linux distros, and how to enable Intents. + ## Intents +__ Go to the [Discord Developer Portal](https://discord.com/developers/applications) and select your bot. Now move to the bot tab and scroll down. There you should see `Priveledged Gateway Intents`. Enable the `Members` intent. ![Enable Members Intent](https://i.imgur.com/rPePBe6.png) ## Easy: How to install the welcome-bot on a home computer: +__ Make sure that you've installed Python 3.6 or higher before beginning this. ### Linux + First, we want to clone the repository using `git clone`: ``` git clone https://github.com/jcreek/discord.py-welcome-bot.git @@ -40,9 +44,10 @@ After extracting, you can navigate into the folder and just double-click the fil ![Running the file](https://i.imgur.com/pFdAa80.png) ## Advanced: How to install the welcome-bot as a docker container on a server (raspberrypi) +__ ### Building the image - +__ Copy the folder containing the Dockerfile onto the server. Go to the directory that has the Dockerfile and run the following command to build the Docker image from the source code: `docker build -t welcome-bot .`