MisskeyBooruImageBot_v2/README.md

61 lines
1.7 KiB
Markdown
Raw Normal View History

2023-10-10 18:30:38 +00:00
# Gelbooru Image Bot for Misskey
Simple python bot which scrapes images from gelbooru based on specified tags every hour and posts to a misskey instance. The script can handle multiple bots simulatenously.
- Uses a systemd timer.
- Posts original source when available.
- Attempts to optimize downloaded images for size with PIL.
- Attempts to renote the original source if possible.
- Option for posting to hashtags (limits to once per day to avoid drowning out other content).
## Usage
```bash
python .\gelbooru_poster.py --help
Usage: python3 gelbooru-bot.py [--gen-config] [--help]
--gen-config: Add a new bot to the config.json file
--help: Show this help message
No arguments: Run the bot
Note: The values in defaults.json will be used if the values are not set in config.json
```
## Files
### config.json
```json
{
"hololive_images": {
"gelbooru_tags": "hololive",
"gelbooru_tags_exclude": "-sky",
"bot_message": "Hololive Image",
"bot_hashtags": "#hololive",
"misskey_token": "uuuu0hOhrrrlrlrP8888uquqaaaaAUAU",
"max_page_number": 200,
"last_run_time": -1
},
"kancolle": {
"gelbooru_tags": "kantai_collection",
"gelbooru_tags_exclude": "",
"bot_message": ".",
"bot_hashtags": "#kancolle",
"misskey_token": "HHkkuuuutdtdrrrrvWvW8888yayaaaaa",
"max_page_number": 200,
"last_run_time": 1696896202.1551812
}
}
```
### defaults.json
```json
{
"gelbooru_tags": "rating:safe",
"gelbooru_tags_exclude": "",
"bot_message": "Random image from Gelbooru",
"misskey_url": "https://misskey.io/api/",
"misskey_token": "",
"max_page_number": 1000
}
```