| .github | ||
| commands | ||
| tools | ||
| .gitignore | ||
| config.py | ||
| LICENSE | ||
| poetry.toml | ||
| pyproject.toml | ||
| README.md | ||
| run.py | ||
Modufur
An experimental Hikari Discord bot for reverse image searching using SauceNAO & Kheina
Prerequisites
A Unix-based operating system 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 this repository
git clone https://github.com/Myned/Modufur.git
Go to the project folder
cd Modufur
Create a virtual environment and install dependencies
poetry install
Usage
Go to the 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
client = 0 # bot application ID
token = "" # bot token
activity = "" # bot status
saucenao = "" # saucenao token
e621 = "" # e621 token
Updating
Go to the project folder
cd Modufur
Pull changes from the repository
git pull
Remove the virtual environment folder (necessary because of git dependencies)
rm -rf .venv
Reinstall and update the virtual environment
poetry update
Uninstalling
Remove the 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.