forked from gabrielchuang/stats-boye
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathhelptext.txt
122 lines (93 loc) · 3.95 KB
/
helptext.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
!pie -- a pie chart
!bar -- a bar graph
!time -- a time graph
!randomquote/!rq -- gives a random quote
!about/!aboutme -- gives some cool info!
!wordcloud/!cloud -- generates a wordcloud
I am agnostic to order of arguments -- for example, "keyword:`hello` !bar" and "!bar keyword:`hello`"" are equivalent.
--verbose : shows more information.
----------
`split-by` determines how the graph is sliced. For example, if you want a time graph of #general vs #questions, you would split-by:`channel`, whereas if you wanted a bar graph of the users who have said "lol" the most, you would split-by:`user`.
Currently, the only two options are `user` and `channel`.
```split-by:`<either user or channel>` ```
----------
```slices:<number> or slices:`<number>` ``` [pie charts only, default 15]
```bars:<number> or bars:`<number>` ``` [bar charts only, default 10]
```interval:`<either minute or date>` ``` [time graphs only, default date]
if interval:`minute` is included, the time zone is EST.
```num:`<some number from 1 to 10>` ``` [!randomquote only, default 10]
----------
You can filter any query to only include messages that fit certain criteria.
In general, filters will be ANDs of ORs. For example, "!time #general #questions @stats-boye" will include only messages that are from stats-boye AND were sent in (#general OR #questions).
----------
```channel:`general` OR #general OR 502682347309891587 ```
----------
```user:`stats-boye` OR @stats-boye OR 467359252718026752 ```
----------
```role:`Members` OR @Members OR 502683202025029641 ```
----------
```keyword:`hello there!` ```
----------
```date-range:`<date1> -- <date2>`. ```
Dates can be in the format: `YYYY`, `YYYY-MM`, `YYYY-MM-DD`, `YYYY-MM-DD HH`, `YYYY-MM-DD HH:MM`.
All dates are stored in UCT. Intervals are inclusive on both ends.
----------
```pings:`stats-boye` ```
----------
```has-react::thinking: [for non-custom emoji]
has-custom-react:`eyes1` [for custom emoji]```
----------
Exclude users that have been designated as bots using the `!add-bot` command.
```--exclude-bots ```
Only include messages that do/don't have an attachment
```--no-image OR --has-image```
Only include messages that are/aren't pinned
```--pinned OR --not-pinned```
You can precede channel:, user:, role:, and keyword: with ~ (a tilde character) to negate it, e.g. to exclude certain channels or users.
----------
most (currently, all) of these commands are only available to ezekiel, so this is just for his easy reference.
```
!add-ignored-channel <channel>
!refresh_channels
!set_color <channels> <users>
!refresh_users
!refresh_messages
!refresh_channel
!refresh_roles
!refresh_emojis
!add_bot <user>
!remove_bot <user>
!sudo <query, enclosed in triple backticks>
!change_channel_priv <channels> num -- num=2 for ignore-rq, 1 for bot, 0 for normal
!initialize_server
```
----------
stats-boye uses a consistent set of colors (as best as it can) across graphs for users, channels, and roles.
For example, the "ezekiel" slice in "!pie split-by:`user`" is the same color as the "ezekiel" line in "!time @ezekiel".
You can set your own color with `!set_my_color <color>`, where <color> is a hex code like #40FF60.
----------
```
!bar, !pie, !time, !randomquote, !about, !aboutme, !cloud/!wordcloud
bars:`20` OR bars:20
slices:`20` OR slices:20
interval:`date` or interval:`minute`
--verbose
split-by:`user` or split-by:`channel`
channel:`general` OR #general OR 502682347309891587
user:`stats-boye` OR @stats-boye OR 467359252718026752
role:`Members` OR @Members OR 502683202025029641
keyword:`hello there!`
date-range:`<date1> -- <date2>`
date format: `YYYY-MM-DD`, `YYYY-MM-DD HH:MM`
pings:`stats-boye`
has-react:🤔 [for non-custom emoji]
has-custom-react:`eyes1` [for custom emoji]
--exclude-bots
--no-image OR --has-image
--pinned OR --not-pinned
~ to negate channel:, user:, role:, keyword:
!help !basics !filters !admin !misc
!cheatsheet or !cs
```
----------
!help/!statshelp !basics !filters !admin !misc !cheatsheet/!cs