https://github.com/dgw/sopel-boorus
Image board (booru) plugin for Sopel IRC bots
https://github.com/dgw/sopel-boorus
hacktoberfest imageboard irc-bot-plugin sopel-plugin
Last synced: 6 months ago
JSON representation
Image board (booru) plugin for Sopel IRC bots
- Host: GitHub
- URL: https://github.com/dgw/sopel-boorus
- Owner: dgw
- License: other
- Created: 2024-09-18T18:32:18.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2025-03-30T02:41:59.000Z (over 1 year ago)
- Last Synced: 2025-04-11T18:06:25.529Z (over 1 year ago)
- Topics: hacktoberfest, imageboard, irc-bot-plugin, sopel-plugin
- Language: Python
- Homepage:
- Size: 41 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: NEWS
- License: COPYING
Awesome Lists containing this project
README
# sopel-boorus
Image board (booru) plugins for Sopel IRC bots.
## Installing
Releases are hosted on PyPI, so after installing Sopel, all you need is `pip`:
```shell
$ pip install sopel-boorus
```
[**Depending on your Sopel bot's configuration**][sopel-endis-plugins], you
might need to enable or disable the specific booru plugins ([see
below](#booru-plugins-in-this-collection)) that you want your bot to use. You
can do so with [the `sopel-plugins` command][cli-sopel-plugins], e.g.:
```shell
$ sopel-plugins enable gelbooru
```
[cli-sopel-plugins]: https://sopel.chat/docs/run/cli.html#sopel-plugins
[sopel-endis-plugins]: https://sopel.chat/docs/run/plugin#enabling-or-disabling-plugins
### Booru plugins in this collection
* `danbooru`: Supports Danbooru (https://danbooru.donmai.us) links & searches
* `gelbooru`: Supports Gelbooru (https://gelbooru.com) links & searches
### Installation requirements
The `sopel-boorus` package is written with Python 3 and Sopel 8.0+ in mind.
Installation on Python 2, or usage with Sopel 7.x, is not supported.
## Using
### `danbooru`
**Note: Danbooru strictly limits search capabilities for anonymous users,**
making this plugin more useful for link handling than searching, though it will
be able to handle a tag or two just fine if you want a random pic.
Commands: `.danb` or `.danbooru` to search for a random post by tag(s)
Links: Handles post links, e.g. `https://danbooru.donmai.us/posts/`
### `gelbooru`
Commands: `.gelb` or `.gelbooru` to search for a random post by tag(s)
Links: Handles post links, e.g.
`https://gelbooru.com/index.php?page=post&s=view&id=`