←︎ scroll :: f27fc8b


1
commit f27fc8b9ce1cd3ad5f713afe4b147bc653733f85
2
Author: acidvegas <acid.vegas@acid.vegas>
3
Date:   Fri Aug 2 02:11:22 2019 -0400
4
5
    cleanup
6
---
7
 README.md | 46 +++++++++++++++++++++++++---------------------
8
 1 file changed, 25 insertions(+), 21 deletions(-)
9
10
diff --git a/README.md b/README.md
11
index bb4cf7b..ded3b6e 100644
12
--- a/README.md
13
+++ b/README.md
14
@@ -1,31 +1,35 @@
15
 # scroll
16
-> Scroll is full-featured IRC bot that carries a **PENIS PUMP** & will brighten up your mundane chats in your lame channels with some colorful IRC artwork! Designed to be extremely stable, this bot is sure to stay rock hard & handle itself quite well!
17
+> 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!
18
 
19
 ![](screens/preview.png)
20
 
21
 ## Requirements
22
 - [Python](https://www.python.org/downloads/) *(**Note:** This script was developed to be used with the latest version of Python)*
23
-- [Pillow](https://pypi.org/project/Pillow/) *(Required by [core/ascii2png.py](scroll/core/ascii2png.py)*
24
+- [Pillow](https://pypi.org/project/Pillow/) *(Required by [core/ascii2png.py](scroll/core/ascii2png.py))*
25
 
26
 ## Setup
27
-Edit the [core/config.py](scroll/core/config.py) file and then place your art files in the [data/art](scroll/data/art) directory. This repository by itself does not contain any IRC art files. A large organized collection of IRC art can be cloned from the [ircart](https://github.com/ircart/ircart) repository directory into your [data/art](scroll/data/art) directory by doing `git clone https://github.com/ircart/ircart.git $SCROLL_DIR/scroll/data/art` *(change the $SCROLL_DIR to wherever you cloned the source)*.
28
+Edit the [core/config.py](scroll/core/config.py) file and then place your art files in the [data/art](scroll/data/art) directory.
29
+
30
+This repository by itself does not contain any art. A large organized collection of IRC art can be cloned from the [ircart](https://github.com/ircart/ircart) repository directory into your [data/art](scroll/data/art) directory:
31
+
32
+`git clone https://github.com/ircart/ircart.git $SCROLL_DIR/scroll/data/art` *(change the `$SCROLL_DIR` to where you cloned it)*
33
 
34
 **Warning:** Try not to have any filenames in your [data/art](scroll/data/art) directory that are the same as any of the [Commands](#commands) below or you won't be able to play them!
35
 
36
 ## Commands
37
 ### User Commands
38
-| Command                         | Description                                                                                                                                             |
39
-| ------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
40
-| @scroll                         | information about scroll                                                                                                                                |
41
-| .ascii dirs                     | list of ascii directories                                                                                                                               |
42
-| .ascii list                     | list of ascii filenames                                                                                                                                 |
43
-| .ascii png \<url>               | convert an art paste into an image *(\<url> must be a [Pastebin](https://pastebin.com/) or [Termbin](https://termbin.com/) link)*                       |
44
-| .ascii random [dir]             | play random art, optionally from the [dir] directory only                                                                                               |
45
-| .ascii remote \<url>            | play remote art pastes *(\<url> must be a [Pastebin](https://pastebin.com/) or [Termbin](https://termbin.com/) link)*                                   |
46
-| .ascii search \<query>          | search [data/art](scroll/data/art) for \<query>                                                                                                         |
47
-| .ascii stop                     | stop playing art                                                                                                                                        |
48
-| .ascii upload [\<url> \<title>] | list of uploaded art pastes or upload \<url> as \<title> *(\<url> must be a [Pastebin](https://pastebin.com/) or [Termbin](https://termbin.com/) link)* |
49
-| .ascii \<name> [\<trunc>]       | play \<name> art from [data/art](scroll/data/art) *(see usage below)*                                                                                   |
50
+| Command                         | Description                                                                                                                                      |
51
+| ------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
52
+| @scroll                         | information about scroll                                                                                                                         |
53
+| .ascii dirs                     | list of ascii directories                                                                                                                        |
54
+| .ascii list                     | list of ascii filenames                                                                                                                          |
55
+| .ascii png \<url>               | convert an art paste into an image *(must be a [Pastebin](https://pastebin.com/) or [Termbin](https://termbin.com/) link)*                       |
56
+| .ascii random [dir]             | play random art, optionally from the [dir] directory only                                                                                        |
57
+| .ascii remote \<url>            | play remote art pastes *(must be a [Pastebin](https://pastebin.com/) or [Termbin](https://termbin.com/) link)*                                   |
58
+| .ascii search \<query>          | search [data/art](scroll/data/art) for \<query>                                                                                                  |
59
+| .ascii stop                     | stop playing art                                                                                                                                 |
60
+| .ascii upload [\<url> \<title>] | list of uploaded art pastes or upload \<url> as \<title> *(must be a [Pastebin](https://pastebin.com/) or [Termbin](https://termbin.com/) link)* |
61
+| .ascii \<name> [\<trunc>]       | play \<name> art from [data/art](scroll/data/art) *(see usage below)*                                                                            |
62
 
63
 #### Note
64
 The \<trunc> argument for the `.ascii` command allows you to truncate lines off of an ASCII. The data is TOP,BOTTOM,LEFT,RIGHT,SPACES. Top being how many lines to remove from the top. Bottom being the same except from the bottom. Left and right remove characters from each side, and spaces will prefix lines with this many spaces.
65
@@ -33,12 +37,12 @@ The \<trunc> argument for the `.ascii` command allows you to truncate lines off
66
 **Example:** `.ascii funnyguy 3,5,0,10,30` *(This will remove 3 lines from the top, 5 lines from the bottom, no characters from the left, 10 characters from the right, and append 30 spaces before each line)*
67
 
68
 ### Admin Commands *(Private Message)*
69
-| Command                       | Description                                                                                                  |
70
-| ----------------------------- | ------------------------------------------------------------------------------------------------------------ |
71
-| .config [\<setting> \<value>] | view config or change \<setting> to \<value>                                                                 |
72
-| .ignore [\<add/del> \<ident>] | view ignore list or \<add/del> an \<ident> *(\<ident> must be in nick!user@host format, wildcards accepted)* |
73
-| .raw \<data>                  | send \<data> to the server                                                                                   |
74
-| .update                       | update the [data/art](scroll/data/art) directory *(see usage below)*                                         |
75
+| Command                       | Description                                                                                         |
76
+| ----------------------------- | --------------------------------------------------------------------------------------------------- |
77
+| .config [\<setting> \<value>] | view config or change \<setting> to \<value>                                                        |
78
+| .ignore [\<add/del> \<ident>] | view ignore list or \<add/del> an \<ident> *(must be in nick!user@host format, wildcards accepted)* |
79
+| .raw \<data>                  | send \<data> to the server                                                                          |
80
+| .update                       | update the [data/art](scroll/data/art) directory *(see usage below)*                                |
81
 
82
 #### Note
83
 The `.update` command is if you cloned a git repository, like the one mentioned in the [Setup](#setup) section, for your [data/ascii](scroll/data/ascii) directory. This will simply perform a `git pull` on the repository to update it.