Update readme.

This commit is contained in:
dotnet 2023-10-10 14:45:09 -04:00
parent 7dd9aabfc9
commit bca9aee838
1 changed files with 19 additions and 0 deletions

View File

@ -8,6 +8,16 @@ Simple python bot which scrapes images from gelbooru based on specified tags eve
- Attempts to renote the original source if possible. - Attempts to renote the original source if possible.
- Option for posting to hashtags (limits to once per day to avoid drowning out other content). - Option for posting to hashtags (limits to once per day to avoid drowning out other content).
## Installation
Edit the misskeybot.service file with your install path, copy misskeybot.service and misskeybot.timer to `/etc/systemd/system/` then run as root:
```bash
systemctl daemon-reload #Reload unit files
systemctl enable misskeybot.timer #Enable the periodic execution of the script
systemctl start misskeybot.timer #Start the periodic execution of the script
```
## Usage ## Usage
```bash ```bash
@ -19,6 +29,7 @@ Usage: python3 gelbooru-bot.py [--gen-config] [--help]
Note: The values in defaults.json will be used if the values are not set in config.json Note: The values in defaults.json will be used if the values are not set in config.json
``` ```
## Files ## Files
### config.json ### config.json
@ -40,12 +51,18 @@ Usage: python3 gelbooru-bot.py [--gen-config] [--help]
"bot_hashtags": "#kancolle", "bot_hashtags": "#kancolle",
"misskey_token": "HHkkuuuutdtdrrrrvWvW8888yayaaaaa", "misskey_token": "HHkkuuuutdtdrrrrvWvW8888yayaaaaa",
"max_page_number": 200, "max_page_number": 200,
"misskey_url": "https://misskey.io/api/",
"last_run_time": 1696896202.1551812 "last_run_time": 1696896202.1551812
} }
} }
``` ```
- `max_page_number:` Automatically determined by the script.
- `last_run_time:` Used to allow the different bots to post at different times by tracking the last time that specific bot posted.
### defaults.json ### defaults.json
```json ```json
@ -58,3 +75,5 @@ Usage: python3 gelbooru-bot.py [--gen-config] [--help]
"max_page_number": 1000 "max_page_number": 1000
} }
``` ```
- These values are used if not defined in the `config.json`, useful if all bots are on the same url.