scroll/README.md

# 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!

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!

There is no API key needed, no local art files needed, & no reason to not setup scroll in your channel today!

## Dependencies
* [python](https://www.python.org/)
* [chardet](https://pypi.org/project/chardet/) *(`pip install chardet`)*
* [pillow](https://pypi.org/project/pillow/) *(`pip install pillow`)*

## Commands
| Command                              | Description                                                |
| ------------------------------------ | ---------------------------------------------------------- |
| `@scroll`                            | information about scroll                                   |
| `.ascii <name>`                      | play the \<name> art file                                  |
| `.ascii dirs`                        | list of art directories                                    |
| `.ascii img <ur>`                    | convert image \<ur> to art *(experimental, beta status)*   |
| `.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             |

**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.

**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
| Setting     | Description                                                                  |
| ----------- | ---------------------------------------------------------------------------- |
| `flood`     | delay between each command                                                   |
| `ignore`    | directories to ignore in `.ascii random` *(comma seperated list, no spaces)* |
| `lines`     | max lines outside of #scroll                                                 |
| `msg`       | delay between each message sent                                              |
| `paste`     | enable or disable `.ascii play`                                              |
| `png_width` | maximum width for `.ascii img` output                                        |
| `results`   | max results to return in `.ascii search`                                     |


## Preview

![](.screens/preview1.png)

![](.screens/preview2.png)

Come pump with us in **#scroll** on [irc.supernets.org](ircs://irc.supernets.org)

___

###### Mirrors
[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)