2023-06-02 05:43:45 +00:00
# scroll
Scroll is full-featured IRC bot that carries a **PENIS PUMP** & will brighten up all the mundane chats in your lame IRC channels with some colorful IRC artwork! Designed to be extremely stable, this bot is sure to stay rock hard & handle itself quite well!
2023-06-05 11:53:16 +00:00
All of the IRC art is loaded directly from the [ircart ](https://github.com/ircart/ircart ) central repository using the [Github API ](https://docs.github.com/en/rest ), which means that anytime the repository is updated with new art, you can simply `.ascii sync` & then be able to pump the latest art packs!
2023-06-28 19:19:33 +00:00
Designed to be portable, there is no API key needed, no local art files needed, & no reason to not setup scroll in your channel(s) today!
2023-06-02 05:43:45 +00:00
## Dependencies
* [python ](https://www.python.org/ )
* [chardet ](https://pypi.org/project/chardet/ ) *(`pip install chardet`)*
2023-06-26 06:41:28 +00:00
* [pillow ](https://pypi.org/project/pillow/ ) *(`pip install pillow`)*
2023-06-02 05:43:45 +00:00
## Commands
2023-06-25 06:40:06 +00:00
| Command | Description |
| ------------------------------------ | ---------------------------------------------------------- |
| `@scroll` | information about scroll |
| `.ascii <name>` | play the \<name> art file |
| `.ascii dirs` | list of art directories |
2023-06-26 07:21:14 +00:00
| `.ascii img <ur>` | convert image \<ur> to art *(experimental, beta status)* |
2023-06-25 06:40:06 +00:00
| `.ascii list` | list of art filenames |
| `.ascii play <url>` | play the contents of \<url> *(must be a raw pastebin url)* |
| `.ascii random [dir]` | play random art, optionally from the [dir] directory only |
| `.ascii settings` | view settings |
| `.ascii settings <setting> <option>` | change \<setting> to \<option> |
| `.ascii stop` | stop playing art |
| `.ascii sync` | sync the ascii database to pump the newest art |
2023-06-02 05:43:45 +00:00
2023-06-05 11:38:40 +00:00
**NOTE**: You can do `.ascii help` to play the [help.txt ](https://github.com/ircart/ircart/blob/master/ircart/doc/help.txt ) file in your channel.
2023-06-25 06:40:06 +00:00
**NOTE**: The sync & settings commands are admin only! `admin` is a *nick!user@host* mask defined in [scroll.py ](https://github.com/ircart/scroll/blob/master/scroll.py )
## Settings
2023-06-28 19:49:11 +00:00
| Setting | Type | Default | Description |
| ---------------- | ------------ | ------------------------------------------------------------------------------ |
| `flood` | int or float | delay between each command |
| `ignore` | str | directories to ignore in `.ascii random` *(comma seperated list, no spaces)* |
| `lines` | int | max lines outside of #scroll |
| `msg` | int or float | delay between each message sent |
| `paste` | boolean | enable or disable `.ascii play` |
| `png_brightness` | int or float | increase or decrease brightness for `.ascii img` output |
| `png_contrast` | int or float | increase or decrease contrast for `.ascii img` output |
| `png_effect` | str | change the effect for `.ascii img` output *(greyscale, blackwhite, or invert)* |
| `png_palette` | str | palette option for `.ascii img` output *(RGB99 or RGB88)* |
| `png_width` | int | maximum width for `.ascii img` output |
| `results` | int | max results to return in `.ascii search` |
**NOTE**: Setting **0** to `png_brightness` , `png_contrast` , or `png_effect` will disable the setting.
2023-06-25 06:40:06 +00:00
2023-06-02 05:45:38 +00:00
## Preview
2023-06-26 07:57:40 +00:00
2023-06-02 05:45:38 +00:00
2023-06-05 10:48:58 +00:00
Come pump with us in ** #scroll ** on [irc.supernets.org ](ircs://irc.supernets.org )
2023-06-26 06:41:28 +00:00
___
###### Mirrors
2023-06-26 08:00:19 +00:00
[acid.vegas ](https://git.acid.vegas/scroll ) • [GitHub ](https://github.com/ircart/scroll ) • [GitLab ](https://gitlab.com/ircart/scroll ) • [SourceHut ](https://git.sr.ht/~acidvegas/scroll ) • [SuperNETs ](https://git.supernets.org/ircart/scroll )
