forked from cxcfme/KazTron
-
Notifications
You must be signed in to change notification settings - Fork 0
/
config.example.json
229 lines (229 loc) · 8.49 KB
/
config.example.json
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
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
{
"discord": {
"mod_roles": ["role 1", "role 2", "etc."],
"admin_roles": ["role 1", "role 2", "etc."],
"mod_channels": ["channel ID 1", "channel ID 2", "these are channels where mod/non-public commands are allowed"],
"admin_channels": ["channel ID 1", "channel ID 2", "admin-only channels (not automatically considered mod channels)"],
"playing": "status (playing ...) message here",
"token": "bot auth token",
"channel_output": "channel ID for general bot messages (technical/audit mostly)",
"channel_public": "channel ID for public bot usage and some status/notification messages to users",
"channel_test": "channel ID for general bot usage or testing purposes (mostly unused, some commands are allowed here as well as their normal allowed channels)"
},
"core": {
"name": "KazTronExampleBot",
"extensions": ["dice", "discordtools", "fuck", "modnotes", "modnotes.bantools", "modnotes.jointools","modtools", "quotedb", "reminder", "resource_channel", "spotlight", "sprint", "sticky", "test", "userstats", "voicelog", "welcome", "wordfilter"],
"channel_request": "channel ID for requests",
"info_links": {
"link name 1": "http://potato.example/url/to/something",
"link name 2": "http://google.com"
},
"date_format": "%Y-%m-%d",
"datetime_format": "%Y-%m-%d %H:%M",
"datetime_seconds_format": "%Y-%m-%d %H:%M:%S",
"daemon": true,
"daemon_pidfile": "kaztron.pid",
"daemon_user": "For daemon mode, Linux/UNIX username to switch to (optional, leave blank to keep executing user)",
"daemon_group": "For daemon mode, Linux/UNIX group to switch to (optional, can leave blank)",
"daemon_log": "daemon.log"
},
"logging": {
"level": "INFO",
"file": "kaztron.log",
"max_size_kb": 0,
"max_backups": 0,
"gzip_backups": true,
"tags": {
"sqlalchemy.engine": "WARNING",
"asyncprawcore": "INFO",
"websockets.protocol": "INFO",
"discord": "INFO",
"kaztron.config": "INFO",
"kaztron.help_formatter": "INFO"
}
},
"help": {
"jekyll_manual_title_field": "kaz-manual-title",
"jekyll_manual_id_field": "kaz-manual-id",
"jekyll_version_field": "kaz-version",
"jekyll_category_field": "kaz-cog-category"
},
"reddit": {
"client_id": "from reddit",
"client_secret": "from reddit",
"user_agent": "custom user-agent string; follow reddit API guidelines for this, including your reddit username in it"
},
"rolemanager": {
"user_roles": {
"role_name1": {
"join_name": "join command name",
"leave_name": "leave command name",
"join_msg": "Message to send user when the user successfully joins the role.",
"leave_msg": "Message to send when the user successfully leaves the role.",
"join_err": "Message when the user tries to join but is already member of the role.",
"leave_err": "Message when the user tries to leave but is not a role member.",
"join_doc": "Help string for the join command.",
"leave_doc": "Help string for the leave command.",
"delete": true,
"pm": true,
"group": ["command", "subcommand", "etc. - command to group the join/leave commands under, must be Group classes - Optional"],
"name of another argument here": "include other arguments to pass to the discord.ext.commands.command() decorator"
},
"role_name2": {
"join_name": "join command name",
"leave_name": "leave command name",
"join_msg": "Message to send user when the user successfully joins the role.",
"leave_msg": "Message to send when the user successfully leaves the role.",
"join_err": "Message when the user tries to join but is already member of the role.",
"leave_err": "Message when the user tries to leave but is not a role member.",
"join_doc": "Help string for the join command.",
"leave_doc": "Help string for the leave command.",
"delete": false,
"pm": false,
"group": ["command", "subcommand", "etc. - command to group the join/leave commands under, must be Group classes - Optional"],
"name of another argument here": "include other arguments to pass to the discord.ext.commands.command() decorator"
}
},
"mod_roles": {
"role_name1 (same structure as user_roles)": {}
}
},
"blots": {
"check_in_period_weekdays": [2, 3],
"check_in_period_time": "5:00",
"check_in_window_exempt_roles": ["role name", "another role name"],
"check_in_channel": "channel ID here",
"milestone_map": {
"words": {
"role 1 name": 0,
"role 2 name": 10000,
"role 3 name": 25000,
"etc.": 50000
},
"script": {
"role 1 name": 0,
"role 2 name": 100,
"role 3 name": 250,
"etc.": 500
},
"visual": {
"role 1 name": 0,
"role 2 name": 50,
"role 3 name": 100,
"etc.": 200
}
}
},
"dice": {
"channel_dice": "channel ID where dice are allowed"
},
"filter": {
"channel_warning": "channel ID for MODERATOR filter warning/delete notifications"
},
"modnotes": {
"channel_log": "channel ID - for channel to log all new records to (read-only ideally?)",
"channel_mod": "channel ID for notifications to mods (used by extensions)",
"ban_check_interval": 3600,
"ban_role": "role name for banned members",
"ban_temp_enforce": false,
"ban_perma_enforce": false,
"ban_temp_expires": "in 7 days"
},
"modtools": {
"notif_role": "Name of role used to send notifications to all mods",
"channel_mod": "channel ID for notifications to mods (for .report)",
"distinguish_map": {
"mod-role1": "distinguish-role1",
"mod-role2": "distinguish-role2"
},
"wb_images": [
["url1", "artist name 1"],
["url2", "artist name 2"]
]
},
"projects": {
"project_channel": "channel ID",
"max_projects": 3,
"max_projects_map": {
"role name 1": 1,
"role name 2": 99
},
"timeout_confirm": 120,
"timeout_wizard": 1800
},
"quotedb": {
"grab_search_max": 100,
"datetime_format": "one of: seconds, datetime, date",
"show_channel": false
},
"reminders": {
"max_per_user": 10,
"renew_limit": 25,
"renew_interval_min": 600
},
"resource_channel": {
"channel": "Channel ID",
"reactions": ["\uD83D\uDC4D", "\uD83D\uDC4E"],
"allow_strings": ["https://", "http://"],
"allow_re_strings": [],
"deny_strings": [],
"deny_re_strings": [],
"allow_uploads": true
},
"spotlight": {
"name": "World Spotlight",
"channel": "Channel ID",
"audience_role": "Spotlight Audience role name",
"host_role": "Spotlight Host role name",
"mod_role": "Role name to inform moderators of spotlight start/end (or blank)",
"spreadsheet_id": "Google Spreadsheet ID",
"spreadsheet_range": "Google Spreadsheet range name",
"start_date_format": "%d",
"end_date_format": "%d %B",
"duration": 172800,
"reminders": [21600, 43200, 64800, 86400, 108000, 129600, 151200, 169200],
"queue_reminder_offset": 14400
},
"sprint": {
"channel": "channel ID",
"role_sprint": "role name - people currently sprinting",
"role_follow": "role name - people who want to get notified about new sprints",
"delay_default": 300,
"delay_max": 900,
"duration_default": 1500,
"duration_min": 300,
"duration_max": 3600,
"finalize_time": 300,
"report_time": "time at which reports are generated weekly, default 17:00"
},
"sticky": {
"delay": 300
},
"subwatch": {
"reddit_username": "reddit user to connect from (can be omitted to use the first logged-in user)",
"check_interval": 60,
"min_post_interval": 300,
"max_posts_per_interval": 2
},
"userstats": {
"ignore_users": ["user ID 1", "user ID 2", "etc"],
"ignore_channels": ["channel ID 1", "channel ID 2", "etc"]
},
"voicelog": {
"voice_text_channel_map": {
"voice channel ID 1": "text channel ID 1 (where join/part messages are output)",
"voice channel ID 2": "text channel ID 2 (can be same as text channel ID 1)",
"etc.": "etc."
},
"role_voice": "Name of the role to assign while in voice channels"
},
"welcome": {
"channel_welcome": "channel ID for public welcome messages",
"channel_rules": "channel ID for users to read rules (linked to in welcome msg)",
"public_join": true,
"public_quit": true
},
"wikichannel": {
"reddit_username": "reddit username (must be logged in/authorized in the app already)"
}
}