mirror of
https://github.com/myned/modufur.git
synced 2024-12-23 22:27:27 +00:00
Discord bot for reverse image searching
.github | ||
commands | ||
tools | ||
.gitignore | ||
config.py | ||
LICENSE | ||
modufur.service | ||
poetry.toml | ||
pyproject.toml | ||
README.md | ||
run.py |
Modufur
An experimental Hikari Discord bot for reverse image searching using SauceNAO & Kheina
Prerequisites
Linux is used for the following commands
WSL can be used to run Linux on Windows, but is not required to run the bot
Requirements
Installing
- Clone repository
git clone https://github.com/Myned/Modufur.git
- Go to project folder
cd Modufur
- Create a virtual environment and install dependencies
poetry install
Usage
- Go to project folder
cd Modufur
- Run with optimizations
poetry run python -OO run.py
Setup
Run to create config.toml
The file will automatically generate if it does not exist
guilds = [] # guild IDs to register commands, empty for global
master = 0 # guild ID to register owner commands
client = 0 # bot application ID
token = "" # bot token
activity = "" # bot status
saucenao = "" # saucenao token
e621 = "" # e621 token
systemd service
Run in the background on most Linux machines
This assumes that the project folder is located at ~/.git/Modufur
Change the WorkingDirectory
path in modufur.service
if this is not the case
- Go to project folder
cd Modufur
- Copy user service file
cp modufur.service ~/.config/systemd/user
- Reload user daemon
systemctl --user daemon-reload
- Start and enable service on login
systemctl --user enable --now modufur
- Enable lingering to start user services on boot
sudo loginctl enable-linger username
Updating
- Go to project folder
cd Modufur
- Pull changes from repository
git pull
- Update virtual environment
poetry update
- Restart systemd user service
systemctl --user restart modufur
Uninstalling
- Stop and disable systemd user service
systemctl --user disable --now modufur
- Remove systemd user service file
rm ~/.config/systemd/user/modufur.service
- Optionally disable lingering
sudo loginctl disable-linger username
- Remove project folder
rm -rf Modufur
Contributing
- Fork this repository on GitHub
- Make changes to the code
- Format the code with Black inside the project folder
poetry run python black .
- Commit the changes to the fork
- Create a pull request from the fork
FAQ
What happened to the public bot?
My Discord account was deleted, so a new bot had to be created.
Why not link to the public bot here?
Although public, I do not wish for it to be excessively used due to API quotas.
Why can't I send explicit images to the bot?
Discord currently has no way to disable scanning content for bots.
You can send links uploaded elsewhere instead.