61 lines
1.8 KiB
Markdown
61 lines
1.8 KiB
Markdown
# muzovkantV2
|
|
### shitty discord bot
|
|
## overall
|
|
you can use this as a base for your discord bot by making your own cogs, installing cogs from [cogdump](https://git.rejnronuz.1337.cx/rejnronuz/muzovkant-cogdump), or as is.
|
|
|
|
## installation
|
|
1. clone the repo
|
|
```bash
|
|
git clone https://github.com/rejnronuzz/muzovkantv2.git
|
|
cd muzovkantv2
|
|
```
|
|
2. install the requirements. you might need to enter a venv on some systems.
|
|
```bash
|
|
pip install -r requirements.txt
|
|
```
|
|
3. insert your discord bot token into the .env file.
|
|
*it should look something like this:*
|
|
```
|
|
DISCORD_TOKEN=abc123abc
|
|
```
|
|
you can then edit the configs of main.py and the configs of each cog to your liking.
|
|
|
|
## usage
|
|
the bot is running when the main.py script is running.
|
|
|
|
### systemd service
|
|
you can configure a systemd service for this bot.
|
|
[systemd_service.sh](systemd_service.sh) is ONLY for systemd systems.
|
|
|
|
(*tested on Ubuntu 24.04*)
|
|
|
|
simply do:
|
|
```
|
|
chmod +x systemd_service.sh
|
|
./systemd_service.sh
|
|
```
|
|
the systemd service will now start and auto start on reboot.
|
|
|
|
#### updating with systemd service
|
|
keep in mind that after updating with the systemd service enabled, you will need to restart the service.
|
|
so the update workflow looks something like this:
|
|
```
|
|
git pull origin main
|
|
sudo systemctl restart muzovkantv2
|
|
```
|
|
### cogs
|
|
|
|
### where to get cogs?
|
|
pre-made ones are at [cogdump](https://git.rejnronuz.1337.cx/rejnronuz/muzovkant-cogdump)
|
|
you will have to configure them, though
|
|
|
|
### installing cogs
|
|
refer to [installation guide from cogdump.](https://git.rejnronuz.1337.cx/rejnronuz/muzovkant-cogdump#installation-of-cogs)
|
|
|
|
## contacting
|
|
if you have any feedback, contact me on git issues or/and discord. if you want to add any functionality to this bot, make a PR.
|
|
when submitting a bug report, make sure to attach the bot.log files. they generate automatically in root directory.
|
|
|
|
|
|
|