myned/watcher
1
0
Fork 0
mirror of https://github.com/myned/watcher.git synced 2024-11-01 12:22:38 +00:00
Code Issues Activity
Discord bot for activity roles
41 commits 1 branch 0 tags 70 KiB
Python 100%
Find a file
Myned b72c84e66d
git: remove funding 
Signed-off-by: Myned <dev@bjork.tech>
2024-09-08 20:25:09 -05:00
commands Fix limbo index error 2023-01-04 11:47:05 -06:00
tasks Fix error on webhook events 2023-03-16 16:55:44 -05:00
tools Add inactive command 2022-07-05 17:19:59 -05:00
.gitignore Ignore database files 2022-06-14 18:20:57 -05:00
config.py Add inactive command 2022-07-05 17:19:59 -05:00
LICENSE Initial commit 2022-06-07 16:22:48 -05:00
poetry.toml Initial upload 2022-06-08 20:59:15 -05:00
pyproject.toml Use static dependency versions 2024-05-24 17:17:41 -05:00
README.md git: remove funding 2024-09-08 20:25:09 -05:00
run.py ?run.py [ fixed install to Client based on version of Hikari Miru 4.0.0 ] 2024-05-24 16:33:37 +02:00
watcher.service Update repo name 2023-03-17 01:16:20 -05:00

README.md

Watcher

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

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/watcher.git
  1. Go to project folder
cd watcher
  1. Create a virtual environment and install dependencies
poetry install

Usage

  1. Go to project folder
cd watcher
  1. Run with optimizations
poetry run python -OO run.py

Setup

Starting

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

Inviting

  1. Setup a bot application at Discord's developer portal
  2. Under General Information, paste APPLICATION ID into config.toml > client
  3. Under Bot, click Add Bot
  4. Under Bot, enable SERVER MEMBERS INTENT (necessary for limbo command)
  5. Under Bot, paste TOKEN into config.toml > token
  6. Under OAuth2 > URL Generator, check SCOPES > bot and BOT PERMISSIONS > Manage Roles and Read Messages/View Channels
  7. Paste generated URL into a browser to invite the bot

systemd service

Run in the background on most Linux machines
This assumes that the project folder is located at ~/.git/watcher
Change the WorkingDirectory path in watcher.service if this is not the case

  1. Go to project folder
cd watcher
  1. Copy user service file
cp watcher.service ~/.config/systemd/user
  1. Replace user in WorkingDirectory with current user
sed -i "s|\(WorkingDirectory=/home/\)user|\1$(whoami)|" ~/.config/systemd/user/watcher.service
  1. Reload user daemon
systemctl --user daemon-reload
  1. Start and enable service on login
systemctl --user enable --now watcher
  1. Enable lingering to start user services on boot
sudo loginctl enable-linger $(whoami)

Updating

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

Uninstalling

  1. Stop and disable systemd user service
systemctl --user disable --now watcher
  1. Remove systemd user service file
rm ~/.config/systemd/user/watcher.service
  1. Optionally disable lingering
sudo loginctl disable-linger username
  1. Remove 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 black .
  4. Commit the changes to the fork
  5. Create a pull request from the fork

Credits

hikari
hikari-lightbulb
hikari-miru