watcher/README.md

Watcher

An experimental Hikari Discord bot for assigning active and inactive roles based on member activity

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

Git
Python 3.10+
Poetry

Installing

Clone this repository

git clone https://github.com/Myned/Watcher.git

Go to the project folder

cd Watcher

Create a virtual environment and install dependencies

poetry install

Usage

Go to the project folder

cd Watcher

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

client = 0 # bot application id
token = "" # bot token
activity = "you" # bot status
db = "watcher.db" # sqlite3 db filepath
guild = 0 # guild id to watch
active = 0 # active role id
inactive = 0 # inactive role id
duration = 0 # time in seconds before considered inactive

Updating

Go to the project folder

cd Watcher

Pull changes from the repository

git pull

Update the virtual environment

poetry update

Uninstalling

Remove the project folder

rm -rf Watcher

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

Credits

hikari
hikari-lightbulb
hikari-miru