https://github.com/adambirds/python-discord-insult-bot
A Discord Bot Written in Python to Dish Out Insults.
https://github.com/adambirds/python-discord-insult-bot
Last synced: 3 months ago
JSON representation
A Discord Bot Written in Python to Dish Out Insults.
- Host: GitHub
- URL: https://github.com/adambirds/python-discord-insult-bot
- Owner: adambirds
- License: gpl-3.0
- Created: 2022-02-17T04:23:50.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-02-19T03:47:37.000Z (over 3 years ago)
- Last Synced: 2025-01-08T05:02:55.374Z (5 months ago)
- Language: Python
- Size: 35.2 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: docs/contributing/commit-guidelines.md
- Funding: FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# python-discord-insult-bot
[](https://github.com/psf/black)
[](https://github.com/python/mypy)
A Discord Bot Written in Python to Dish Out Insults.
## Support
For support using this bot, please join our [official support server](https://discord.gg/f5veJaa4ZX) on [Discord](https://discord.com).
[](https://discord.gg/f5veJaa4ZX)
## Source
The source code can be found [here](https://github.com/adambirds/python-discord-insult-bot).
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 generated[here](https://discord.com/developers/applications).
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](https://github.com/adambirds/python-discord-insult-bot/blob/main/LICENSE).
## Contributing
Anybody is welcome to contribute to this project. I just ask that you check out our contributing guidelines
[here](https://github.com/adambirds/python-discord-insult-bot/blob/main/docs/contributing/contributing.md) first.