Welcome
WM Bot
A advanced bot with more than 220 commands to fit your needs
Explore the commands »
View Demo · Report Bug · Request Feature
Table of Contents
About The Project
I started learning python around March 2020. This project was started as a way to become better at python in July 7th 2020. And the code you'll see in this repository was written between then and now. some code may have really bad practices because of it. if you find any issues with the code, please report them to me in my discord: Wasi Master#6969
or open a pull request. if you find any bugs or have any ideas then open a issue in the repository
Built With
Getting Started
Almost every folder on this repository has a readme file that you can check for more information on what that specific folder is for
To get a local copy up and running follow these simple steps.
Prerequisites
This is an example of how to list things you need to use the software and how to install them.
- 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
-
Clone the repo
git clone https://github.com/wasi-master/wm_bot.git
-
Change directory to the cloned repo
cd wm_bot/src
-
Rename the folder config_example to config
- Linux/MacOS:
mv config_example config
- Windows:
ren config_example config
-
Edit the config files to add your bot token and the database credentials. (For instructions see the
readme.md
file in each config directory) -
Run the required commands in your database
psql username -h hostname -d database_name -f db_setup.sql
And replace
username
with your username.hostname
with your database hostname anddatabase_name
with your database name. -
Install Required packages
pip install -r requirements.txt
-
Run the bot
- Windows:
py main.py
- Linux:
python main.py
- MacOS:
python3 main.py
Copying Code
If you want to copy any code from this repo please keep these in mind
-
Read the license and what it allows and disallows
-
If you want to copy a whole command
- If you are in a cog keep
@commands.command
and if you are not in a command replace@commands.command
with@bot.command
or@client.command
depending on what you named your bot
- If you are in a cog keep
-
If you see any functions/classes that you don't understand/don't know where it is defined, in the desktop version of github you can click the function/class name and see where it is defined
Bad Practice, Code, or Code Style
If you find any code that you think is bad practice, code, or code style, please report it to me in my discord: Wasi Master#6969
or open a pull request or a issue. if you find any bugs or have any ideas then open a issue in the repository
Usage
For command examples, please refer to the Documentation
Contributing
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.
-
Fork the Project
-
Add or Change some cool code
-
Format the code with
black
andisort
-
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
-
-
Commit your Changes
-
Push your code
-
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