Welcome

WM Bot

With over 220 commands, this powerful bot can be tailored to meet your needs
Explore the commands »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Copying Code
4. Usage
5. Roadmap
6. Contributing
7. License
8. Contact
9. Acknowledgements

About The Project

Around March 2020, I began learning Python. On July 7th, 2020, I started this project as a way of improving my knowledge of Python. I've written the code in this repository between then and now, so it may contain some bad practices. I would appreciate it if you reported any issues to me in my Discord: Wasi Master#6969 or opened a pull request. Please open an issue if you see any bugs or have any suggestions

Built With

• python
• discord.py
• dpylint
• vscode discord.py snippets

Getting Started

This repository has a readme file for almost every folder so you can learn more about what is contained in that folder

To get a local copy up and running follow these simple steps.

Prerequisites

The following are the things you need to install in order to run the bot

• python: Download and install python 3.8+ from https://python.org
• git: Download and install git from https://git-scm.com
• postgresql Download and install postgresql from http://www.postgresql.org

Instructions

1. Clone the repo

   git clone https://github.com/wasi-master/wm_bot.git

2. Change directory to the cloned repo

   cd wm_bot/src

3. Rename the folder config_example to config

   • Linux/MacOS:

   mv config_example config

   • Windows:

   ren config_example config

4. Insert the bot token and database credentials into the config files. (Instructions are in each directory's readme.md file)

5. Run the required commands in your database (either use this command or do it another way)

   psql <username> -h <hostname> -d <database_name> -f db_setup.sql

   And don't forget to replace <username> with your username. <hostname> with your database hostname and <database_name> with your database name.

6. Install Required packages

   pip install -r requirements.txt

7. Add the required emojis to your desired server using the following command

   • Windows:

   py emoji_adder

   • Linux:

   python emoji_adder

   • MacOS:

   python3 emoji_adder

   After that you can delete the emoji_adder folder or keep it if you ever want to add the emojis ever again

8. Run the bot

   • Windows:

   py main.py

   • Linux:

   python main.py

   • MacOS:

   python3 main.py

Copying Code

Keep these things in mind if you want to copy any code from this repo

• Read the [license] (license) and learn what it permits and disallows

• To copy a whole command:

  1. Keep @commands.command if you are in a cog; otherwise, replace @commands.command with @bot.command or @client.command, according to what your bot instance is named

• Whenever you see a function/class you are unsure about, you can click the name in the desktop version of github to find out where it is defined

Bad Practice, Code, or Code Style

Whenever you find anything that you believe is bad practice, code, or code style, let me know in my discord: Wasi Master#6969 or open an issue/pull request. Please open an issue if you see any bugs or have any suggestions

Usage

For a list of commands this bot has, please refer to the Documentation

Contributing

Contributions are what makes the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project

2. Add or Change some cool code

3. Format the code with black and isort

   • black: https://github.com/ambv/black

     pip install black
     black . # to format all files
     black file.py # to format a single file

   • isort: https://github.com/timothycrosley/isort

     pip install isort
     isort . # to sort all files
     isort file.py # to sort a single file

4. Commit your Changes

5. Push your code

6. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Wasi Master

• Discord: Wasi Master#6969\
• Email: [email protected]\

Acknowledgements

• Python
• discord.py
• Postgresql
• My friends at the discord.py discord server