myned/modufur
1
0
Fork 0
mirror of https://github.com/myned/modufur.git synced 2024-11-01 13:02:38 +00:00
Code Issues Activity
modufur/README.md
Myned 405e75c05f
Update readme
2023-03-06 22:00:17 -06:00

3.7 KiB
Raw Blame History

Modufur

An experimental Hikari Discord bot for reverse image searching using SauceNAO & Kheina

ko-fi

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

Git
Python 3.10+
Poetry

Installing

  1. Clone repository
git clone https://github.com/Myned/Modufur.git
  1. Go to project folder
cd Modufur
  1. Create a virtual environment and install dependencies
poetry install

Usage

  1. Go to project folder
cd Modufur
  1. 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

  1. Go to project folder
cd Modufur
  1. Copy user service file
cp modufur.service ~/.config/systemd/user
  1. Reload user daemon
systemctl --user daemon-reload
  1. Start and enable service on login
systemctl --user enable --now modufur
  1. Enable lingering to start user services on boot
sudo loginctl enable-linger username

Updating

  1. Go to project folder
cd Modufur
  1. Pull changes from repository
git pull
  1. Update virtual environment
poetry update
  1. Restart systemd user service
systemctl --user restart modufur

Uninstalling

  1. Stop and disable systemd user service
systemctl --user disable --now modufur
  1. Remove systemd user service file
rm ~/.config/systemd/user/modufur.service
  1. Optionally disable lingering
sudo loginctl disable-linger username
  1. Remove project folder
rm -rf Modufur

Contributing

  1. Fork this repository on GitHub
  2. Make changes to the code
  3. Format the code with Black inside the project folder 
    poetry run python black .
  4. Commit the changes to the fork
  5. 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.

Credits

hikari
hikari-lightbulb
hikari-miru
songbird-py
pysaucenao