Skip to content

Latest commit

 

History

History
92 lines (58 loc) · 2.89 KB

README.md

File metadata and controls

92 lines (58 loc) · 2.89 KB

python-discord-insult-bot

code style: black mypy coverage GitHub Sponsors

A Discord Bot Written in Python to Dish Out Insults.

Support

For support using this bot, please join our official support server on Discord.

discord

Source

The source code can be found here.

Contributions welcome and gratefully appreciated!

Requirements

Python 3 (Version 3.6 or later).

Installation

This has only been tested on Linux, so preferably use Linux or WSL 2 if on Windows.

Navigate to where you will store the bot files, then run:

git clone [email protected]:adambirds/python-discord-insult-bot.git

Then run:

tools/setup/prep-prod-environment

Then run:

cp example-config.yaml config.yaml

You will then need to edit config.yaml to your needs. You shouldn't delete any of the keys, however the USER_TO_INSULT, INSULT_KEYS and CHANNEL_FOR_TASK can be left empty if you don't want to consistently insult a user every hour.

The ACCESS_TOKEN key can be generatedhere.

You can setup your bot to run as a service by amending the ./python-discord-insult-bot.service file with your working directorys and copying it using the following command:

cp ./python-discord-insult-bot.service /lib/systemd/system/

Then run:

systemctl daemon-reload

Then run:

systemctl start python-discord-insult-bot

And then to ensure it starts when your server does run:

systemctl enable python-discord-insult-bot

Commands and Events

Commands

The bot supports the following commands:

Command Aliases Example Permissions Purpose
!insult !insult @nameofuser Everyone The bot will mention the user and then insult them.

Taks

If you set the USER_TO_INSULT key to a user's ID AND set the CHANNEL_FOR_TASK to a channel ID, they will be insulted every hour in that channel. For this to work you need at least 1 custom insult in the INSULT_LIST key.

License

This project is released under the GNU GENERAL PUBLIC LICENSE v3.

Contributing

Anybody is welcome to contribute to this project. I just ask that you check out our contributing guidelines here first.