scroll

- irc bot to play ascii art
git clone git://git.acid.vegas/scroll.git
README.md (4554B)
      1 # scroll
      2 
      3 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!
      4 
      5 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!
      6 
      7 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!
      8 
      9 ## Dependencies
     10 * [python](https://www.python.org/)
     11 * [chardet](https://pypi.org/project/chardet/) *(`pip install chardet`)*
     12 * [numpy](https://pypi.org/project/numpy/) *(`pip install numpy`)*
     13 * [opencv-python](https://pypi.org/project/opencv-python/) *(`pip install opencv-python`)*
     14 
     15 ## Commands
     16 | Command                                | Description                                                |
     17 | -------------------------------------- | ---------------------------------------------------------- |
     18 | `@scroll`                              | information about scroll                                   |
     19 | `.ascii <name>`                        | play the \<name> art file                                  |
     20 | `.ascii dirs`                          | list of art directories                                    |
     21 | `.ascii img <ur>`                      | convert image \<ur> to art *(experimental, beta status)*   |
     22 | `.ascii list`                          | list of art filenames                                      |
     23 | `.ascii play <url>`                    | play the contents of \<url> *(must be a raw pastebin url)* |
     24 | `.ascii random [dir|query]`            | play random art, optionally from a [dir] or [query]        |
     25 | `.ascii search <query>`                | search art files that match \<query>                       |
     26 | `.ascii settings [<setting> <option>]` | view or change settings                                    |
     27 | `.ascii stop`                          | stop playing art                                           |
     28 | `.ascii sync`                          | sync the ascii database to pump the newest art             |
     29 
     30 **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.
     31 
     32 **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)
     33 
     34 ## Settings
     35 | Setting               | Type         | Description                                                                                  |
     36 | --------------------- | ------------ | -------------------------------------------------------------------------------------------- |
     37 | `flood`               | int or float | delay between each command                                                                   |
     38 | `ignore`              | str          | directories to ignore in `.ascii random` *(comma seperated list, no spaces)*                 |
     39 | `lines`               | int          | max lines outside of #scroll                                                                 |
     40 | `msg`                 | int or float | delay between each message sent                                                              |
     41 | `paste`               | boolean      | enable or disable `.ascii play`                                                              |
     42 | `png_quantize_colors` | int          | quantize color option for `.ascii img` output                                                |
     43 | `png_palette`         | str          | palette option for `.ascii img` output *(RGB99 or RGB88)*                                    |
     44 | `png_width`           | int          | maximum width for `.ascii img` output                                                        |
     45 | `results`             | int          | max results to return in `.ascii search`                                                     |
     46 
     47 ## Preview
     48 
     49 ![](.screens/preview1.png)
     50 
     51 ![](.screens/preview2.png)
     52 
     53 Come pump with us in **#scroll** on [irc.supernets.org](ircs://irc.supernets.org)
     54 
     55 ___
     56 
     57 ###### Mirrors
     58 [acid.vegas](https://git.acid.vegas/scroll) • [GitHub](https://github.com/ircart/scroll) • [GitLab](https://gitlab.com/ircart/scroll) • [SuperNETs](https://git.supernets.org/ircart/scroll)