mirror of
https://github.com/myned/watcher.git
synced 2024-11-01 20:22:38 +00:00
78 lines
2.2 KiB
Markdown
78 lines
2.2 KiB
Markdown
# Watcher
|
|
An experimental [Hikari](https://www.hikari-py.dev) Discord bot for assigning active and inactive roles based on member activity
|
|
|
|
[](https://ko-fi.com/B0B1AUB66)
|
|
|
|
## Prerequisites
|
|
A Unix-based operating system is used for the following commands\
|
|
[WSL](https://docs.microsoft.com/en-us/windows/wsl) can be used to run Linux on Windows, but is not required to run the bot
|
|
## Requirements
|
|
[Git](https://git-scm.com/downloads)\
|
|
[Python](https://www.python.org) 3.10+\
|
|
[Poetry](https://python-poetry.org/docs/master)
|
|
## 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](https://docs.github.com/en/get-started/quickstart/fork-a-repo) this repository on GitHub
|
|
2. Make changes to the code
|
|
3. Format the code with [Black](https://black.readthedocs.io/en/stable) inside the project folder
|
|
```
|
|
poetry run python black .
|
|
```
|
|
4. [Commit](https://github.com/git-guides/git-commit) the changes to the fork
|
|
5. Create a [pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) from the fork
|
|
## Credits
|
|
[hikari](https://github.com/hikari-py/hikari)\
|
|
[hikari-lightbulb](https://github.com/tandemdude/hikari-lightbulb)
|
|
[hikari-miru](https://github.com/HyperGH/hikari-miru)
|