├── .gitattributes ├── .gitignore ├── LICENSE ├── README.md └── bot ├── .env ├── bot.py └── utils.py /.gitattributes: -------------------------------------------------------------------------------- 1 | # Auto detect text files and perform LF normalization 2 | * text=auto 3 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | 9 | # Distribution / packaging 10 | .Python 11 | build/ 12 | develop-eggs/ 13 | dist/ 14 | downloads/ 15 | eggs/ 16 | .eggs/ 17 | lib/ 18 | lib64/ 19 | parts/ 20 | sdist/ 21 | var/ 22 | wheels/ 23 | pip-wheel-metadata/ 24 | share/python-wheels/ 25 | *.egg-info/ 26 | .installed.cfg 27 | *.egg 28 | MANIFEST 29 | 30 | # PyInstaller 31 | # Usually these files are written by a python script from a template 32 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 33 | *.manifest 34 | *.spec 35 | 36 | # Installer logs 37 | pip-log.txt 38 | pip-delete-this-directory.txt 39 | 40 | # Unit test / coverage reports 41 | htmlcov/ 42 | .tox/ 43 | .nox/ 44 | .coverage 45 | .coverage.* 46 | .cache 47 | nosetests.xml 48 | coverage.xml 49 | *.cover 50 | *.py,cover 51 | .hypothesis/ 52 | .pytest_cache/ 53 | 54 | # Translations 55 | *.mo 56 | *.pot 57 | 58 | # Django stuff: 59 | *.log 60 | local_settings.py 61 | db.sqlite3 62 | db.sqlite3-journal 63 | 64 | # Flask stuff: 65 | instance/ 66 | .webassets-cache 67 | 68 | # Scrapy stuff: 69 | .scrapy 70 | 71 | # Sphinx documentation 72 | docs/_build/ 73 | 74 | # PyBuilder 75 | target/ 76 | 77 | # Jupyter Notebook 78 | .ipynb_checkpoints 79 | 80 | # IPython 81 | profile_default/ 82 | ipython_config.py 83 | 84 | # pyenv 85 | .python-version 86 | 87 | # pipenv 88 | # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. 89 | # However, in case of collaboration, if having platform-specific dependencies or dependencies 90 | # having no cross-platform support, pipenv may install dependencies that don't work, or not 91 | # install all needed dependencies. 92 | #Pipfile.lock 93 | 94 | # celery beat schedule file 95 | celerybeat-schedule 96 | 97 | # SageMath parsed files 98 | *.sage.py 99 | 100 | # Environments 101 | # .env # Removed so that empty env file can be committed for tutorial 102 | .venv 103 | env/ 104 | venv/ 105 | ENV/ 106 | env.bak/ 107 | venv.bak/ 108 | 109 | # Spyder project settings 110 | .spyderproject 111 | .spyproject 112 | 113 | # Rope project settings 114 | .ropeproject 115 | 116 | # mkdocs documentation 117 | /site 118 | 119 | # mypy 120 | .mypy_cache/ 121 | .dmypy.json 122 | dmypy.json 123 | 124 | # Pyre type checker 125 | .pyre/ 126 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Discord Bot in Python Tutorial 2 | A simple discord bot as a teaching exercise for learning Python and Discord.py. 3 | This exercise is aimed at beginner programmers who have some experience with python 4 | but want a simple project to practice their skills on. It's also suitable for anyone 5 | who wants to start a discord bot using discord.py! 6 | 7 | You can view a completed version of this project [here](https://github.com/Ztuu/Discord-Python-Bot-Model-Answer) 8 | which I have created as a model answer. 9 | 10 | ## Before You Start 11 | Before you start with the tasks below you will have to create a bot within the Discord developer portal. 12 | 13 | Follow [this tutorial](https://realpython.com/how-to-make-a-discord-bot-python/) 14 | to create your discord application and bot. 15 | Once you have created your discord application and bot you can fork this repository 16 | to get a copy downloaded to your machine for working on. 17 | 18 | You will need to edit the .env file included in this project with your discord bot 19 | token as described in the tutorial above. 20 | (Normally .env files should not be committed to repositories but in this case a 21 | blank version has been included for simplicity. Make sure you do not commit your 22 | token to your own repository if you commit one. Edit the .gitignore and look for 23 | the line with .env. Remove the # to uncomment this line and make sure you do not 24 | commit the file to your repo.) 25 | 26 | ## Once Your Bot is Running 27 | Once you have the bot running on your server you can use the !test command to check 28 | if it is functioning correctly. The bot should reply with a message in the same 29 | channel saying "test successful". Open up the bot.py file and take a look over the 30 | code, try to understand what each section does and use the comments to help you. 31 | 32 | Take a look at the code responsible for the test command(line 64). 33 | You will mimic this code when creating your own commands. You will see there is 34 | also a stop command for 35 | stopping the bot from running. This is a useful development tool I added as 36 | exiting the bot from the command line can have a significant delay. 37 | Make sure to remove this if you publish your bot! 38 | 39 | - - - - 40 | 41 | ## Tasks 42 | 1. When a user types "!hello" the bot should send a message in that channel saying "Hello World!". 43 | 44 | 2. Update the previous code so that when a user types "!hello" the bot sends a message saying "Hello *@username*!". *(hint: You can get the user who sent the command by using message.author.mention)*. 45 | 46 | 3. When a user types "!compliment" the bot sends a message saying "You look nice today *@username*". 47 | 48 | 4. Update the previous command to send a random compliment from a list of compliments you define. 49 | 50 | 5. When a user comes online send them a message saying "Hello *@username*!" *(hint: The code to handle detecting when a user comes online has been done for you, you just need to add in sending a message to the channel!)*. 51 | 52 | 6. Adjust the previous code by adding a random compliment after greeting the user. 53 | *(hint: don't copy your compliment code from earlier, create a get_compliment function you can use for the !compliment command and when users come online)* 54 | 55 | 7. We're going to make a random number guessing game. When the user types "!guess X" (where X is a number) the bot should generate a random number from 1 to 100 and send a message based on whether the user's number and the bot's number match. If they match say "That's a match!" otherwise say "Sorry, you guessed X but I was thinking of Y" (where Y is the random number the bot came up with). *(hint: this is the first task that requires you to take more than one argument in the user's command. The arguments have already been loaded for you into split_message.)* 56 | 57 | 8. Does the "!guess" command you wrote in the previous part handle if the user enters an invalid command? For example what if they type "!guess foo" or "!guess". Test your code and edit it so that you can handle non-integer arguments, or the user not entering a guess at all. 58 | 59 | 9. If you haven't already, add a different error message if the user guesses a number not between 1 and 100. 60 | 61 | 10. Add a cat image to your project in the same folder as bot.py. When a user types "!meow" send an this image embedded in a message. 62 | *(hint: here is the [discord.py documentation for creating a file object](https://discordpy.readthedocs.io/en/latest/api.html?highlight=file#discord.File). The simplest way is to create a file with my_file = discord.File(filename). The file object can then be sent to a channel by adding a file argument to a message `channel.send(response, file=my_file)`. Remember to add the image to the same folder as bot.py!)* 63 | 64 | 11. Add several cat images to your project and create a list with all the filenames. Modify the "!meow" command to send a random image. 65 | 66 | 12. Having our filenames hardcoded in a list doesn't seem like a great idea If someone changes a filename our program could break, and every time we add a photo we'll have to manually add the filename to our list. To improve this change your code so that when the bot starts up it loads all your image filenames into our list instead. First put all your cat images in a folder in the same directory as the bot.py script called "cat_photos", then in your code loop over the filenames in this folder and add them to our list. *(hint: You can use [os.listdir(path)](https://docs.python.org/3/library/os.html#os.listdir) to get a list of the filenames in a directory, which you can then iterate over in your code! If you named your folder and put it in the correct place try `for filename in os.listdir('cat_photos'). You will also have to modify the code for creating your discord file object as you have to load the photo from a folder. We can use filepath = os.path.join(folder_name, filename) to connect our folder and filename and create our file with discord.File(filepath).`)*. 67 | 68 | - - - - 69 | ## Useful Stuff 70 | * [Discord.py docs](https://discordpy.readthedocs.io/en/latest/ "Discord.py docs") 71 | * [Discord.py FAQS](https://discordpy.readthedocs.io/en/latest/faq.html "Discord.py faqs") 72 | * ["How to Make a Discord Bot in Python"](https://realpython.com/how-to-make-a-discord-bot-python/#responding-to-events, "How to Make a Discord Bot in Python") - The tutorial I used for the initial bot setup. 73 | * [Discord Developer Portal](https://discord.com/developers/applications, "Discord Developer Portal") 74 | * [Python Docs](https://docs.python.org/3/contents.html "Python Docs") - The full Python documentation. 75 | * [Python OS Module](https://docs.python.org/3/library/os.html) - Useful for browsing files/directories and managing filepaths. 76 | * [Model Answer](https://github.com/Ztuu/Discord-Python-Bot-Model-Answer) - A model answer repository I created by completing the tasks myself. 77 | 78 | 79 | 80 | Copyright 2020 Stuart Paterson 81 | 82 | Licensed under the Apache License, Version 2.0 (the "License"); 83 | you may not use this file except in compliance with the License. 84 | You may obtain a copy of the License at 85 | 86 | [http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0) 87 | 88 | Unless required by applicable law or agreed to in writing, software 89 | distributed under the License is distributed on an "AS IS" BASIS, 90 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 91 | See the License for the specific language governing permissions and 92 | limitations under the License. 93 | -------------------------------------------------------------------------------- /bot/.env: -------------------------------------------------------------------------------- 1 | DISCORD_TOKEN= # Your token goes here! 2 | -------------------------------------------------------------------------------- /bot/bot.py: -------------------------------------------------------------------------------- 1 | # APACHE LICENSE 2 | # Copyright 2020 Stuart Paterson 3 | # 4 | # Licensed under the Apache License, Version 2.0 (the "License"); 5 | # you may not use this file except in compliance with the License. 6 | # You may obtain a copy of the License at 7 | # 8 | # http://www.apache.org/licenses/LICENSE-2.0 9 | # 10 | # Unless required by applicable law or agreed to in writing, software 11 | # distributed under the License is distributed on an "AS IS" BASIS, 12 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | # See the License for the specific language governing permissions and 14 | # limitations under the License. 15 | 16 | 17 | # External Packages 18 | import os 19 | import discord 20 | from dotenv import load_dotenv 21 | 22 | # Local Files 23 | import utils 24 | 25 | # Create the bot 26 | load_dotenv() 27 | TOKEN = os.getenv('DISCORD_TOKEN') 28 | client = discord.Client() 29 | 30 | 31 | @client.event 32 | async def on_ready(): 33 | # Triggered when starting up the bot 34 | print(f'{client.user} has connected to Discord!') 35 | 36 | 37 | @client.event 38 | async def on_member_update(before, after): 39 | if str(before.status) == "offline" and str(after.status) == "online": 40 | # When a user comes online 41 | channel = utils.get_channel_by_name(client, after.guild, 'general') 42 | try: 43 | # Send your message when a user comes online here! 44 | pass 45 | except discord.errors.Forbidden: 46 | pass 47 | 48 | 49 | @client.event 50 | async def on_message(message): 51 | if message.author == client.user: 52 | # Ignore messages this bot sends 53 | return 54 | 55 | current_channel = message.channel 56 | 57 | if message.content and len(message.content) > 1 and message.content[0] == '!': 58 | # First we extract the message after the ! then split it on spaces to 59 | # get a list or the arguments the user gave 60 | message_text = message.content[1:] 61 | split_message = message_text.split(" ") 62 | command = split_message[0] 63 | 64 | if command == "test": 65 | response = "test successful" 66 | await current_channel.send(response) 67 | elif command == "stop": 68 | await client.logout() 69 | # elif command == "foo": 70 | # # Add your extra commands in blocks like this! 71 | # pass 72 | 73 | # Run the bot 74 | client.run(TOKEN) 75 | -------------------------------------------------------------------------------- /bot/utils.py: -------------------------------------------------------------------------------- 1 | # APACHE LICENSE 2 | # Copyright 2020 Stuart Paterson 3 | # 4 | # Licensed under the Apache License, Version 2.0 (the "License"); 5 | # you may not use this file except in compliance with the License. 6 | # You may obtain a copy of the License at 7 | # 8 | # http://www.apache.org/licenses/LICENSE-2.0 9 | # 10 | # Unless required by applicable law or agreed to in writing, software 11 | # distributed under the License is distributed on an "AS IS" BASIS, 12 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | # See the License for the specific language governing permissions and 14 | # limitations under the License. 15 | 16 | 17 | def get_channel_by_name(client, guild, name): 18 | """Returns a channel by name from a specific guild""" 19 | for server in client.guilds: 20 | if server == guild: 21 | for channel in server.text_channels: 22 | if channel.name == name: 23 | return channel 24 | --------------------------------------------------------------------------------