https://github.com/sopel-irc/sopel-rainbow
A Sopel plugin to make things RAINBOW COLORED.
https://github.com/sopel-irc/sopel-rainbow
hacktoberfest irc irc-bot irc-bot-plugin sopel sopel-plugin
Last synced: 7 months ago
JSON representation
A Sopel plugin to make things RAINBOW COLORED.
- Host: GitHub
- URL: https://github.com/sopel-irc/sopel-rainbow
- Owner: sopel-irc
- License: other
- Created: 2020-10-16T07:09:19.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-09-25T21:33:30.000Z (9 months ago)
- Last Synced: 2024-11-10T01:42:54.518Z (7 months ago)
- Topics: hacktoberfest, irc, irc-bot, irc-bot-plugin, sopel, sopel-plugin
- Language: Python
- Homepage:
- Size: 13.7 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: COPYING
Awesome Lists containing this project
README
# sopel-rainbow
A Sopel plugin to make things RAINBOW COLORED.
## Installing
Releases are hosted on PyPI, so after installing Sopel, all you need is `pip`:
```shell
$ pip install sopel-rainbow
```
## Configuring
The easiest way to configure `sopel-rainbow` is via Sopel's configuration
wizard—simply run `sopel-plugins configure rainbow` and enter the values for
which it prompts you.
### `order` setting
By default, `sopel-rainbow` outputs colors in the "standard" rainbow `order`,
ROYGBIV, subject to receiving clients' use of the customary meanings for IRC
color codes 0-15. If set explicitly in your Sopel config file, this default
value would look like:
```ini
[rainbow]
order =
4
7
8
3
12
2
6
```
If you want to get creative (or cater to a community with shared color norms
that differ from the "de facto" values established by mIRC and friends)
override the `order` with your own list of _numeric_ codes:
```ini
[rainbow]
order = # Americans and French can fight over this one
4
0
2
```
### `random_start` setting
Starting the rainbow at the beginning of the `order` every time is also
default behavior. If you want the rainbow to start at a random place every
time instead, set the Boolean option `random_start` to `yes` or `on`:
```ini
[rainbow]
random_start = on
```
## Dependencies
* Sopel version 7.1 or higher
* Python 3.8 or higher
Sopel 7.x should still run on Python 2.7 or older Python 3 releases, but it's
not maintained any more; and neither is this plugin tested on anything older.