ircart/scroll
ircart/scroll
1
Fork 0
mirror of git://git.acid.vegas/scroll.git synced 2024-11-07 08:46:45 +00:00
Code Issues Activity

Updated README settings

Browse Source
This commit is contained in:
Dionysus 2023-06-28 15:19:33 -04:00
parent 3d39ea9cb7
commit a21e7e2f6a
Signed by: acidvegas
GPG Key ID: EF4B922DB85DC9DE
1 changed files with 12 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@ -4,7 +4,7 @@ Scroll is full-featured IRC bot that carries a **PENIS PUMP** & will brighten up
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! 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! 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!
## Dependencies ## Dependencies
* [python](https://www.python.org/) * [python](https://www.python.org/)
@ -31,16 +31,17 @@ There is no API key needed, no local art files needed, & no reason to not setup
**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) **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 ## Settings
| Setting | Description | | Setting | Description |
| ----------- | ---------------------------------------------------------------------------- | | -------------- | ---------------------------------------------------------------------------- |
| `flood` | delay between each command | | `flood` | delay between each command |
| `ignore` | directories to ignore in `.ascii random` *(comma seperated list, no spaces)* | | `ignore` | directories to ignore in `.ascii random` *(comma seperated list, no spaces)* |
| `lines` | max lines outside of #scroll | | `lines` | max lines outside of #scroll |
| `msg` | delay between each message sent | | `msg` | delay between each message sent |
| `paste` | enable or disable `.ascii play` | | `paste` | enable or disable `.ascii play` |
| `png_width` | maximum width for `.ascii img` output | | `png_contrast` | enable or disable contrast enhancement for `.ascii img` output |
| `results` | max results to return in `.ascii search` | | `png_palette` | palette option for `.ascii img` output *(RGB99 or RGB88)* |
| `png_width` | maximum width for `.ascii img` output |
| `results` | max results to return in `.ascii search` |
## Preview ## Preview