This repository has been archived by the owner on Jul 27, 2019. It is now read-only.
/
SampleBot.yml
338 lines (338 loc) · 10.2 KB
/
SampleBot.yml
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
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
# Sample PurpleIRC bot configuration.
# Most of these options should be self explanatory.
# Place your bot file in the PurpleIRC/bots/ folder.
# NOTE: If you make changes to this file while the server is running use "/irc reloadbotconfigs" to load the changes into memory.
#
# nick - Your bot's unique nickname
nick: AwesomeBot
# If your bot's nick is in use try these alternates. Leave blank for none.
alt-nicks:
- %NICK%_
- %NICK%__
# login - Your bot's login name
login: AwesomeName
# realname
realname: ''
# server - IRC server to join
server: irc.excample.com
# port - IRC server port
port: 6667
# Attempt ssl connection to IRC server
ssl: false
# Trust all SSL certs
trust-all-certs: false
# Bind address
bind: ''
# Auto split length for long messages
max-line-length: 440
# Character encoding. Leave blank for Java default.
charset: ''
# show irc server motd on connect
show-motd: false
# autoconnect - Connect automatically on startup
autoconnect: 'false'
# password - Server password if needed
password: ''
# identify password (sent to NickServ)
ident-password: ''
# command-prefix - The bot will listen for commands that start with this.
command-prefix: '.'
# quit-message - Message the bot will send when it quits the server
quit-message: '&r[&5PurpleIRC&r] &rGood bye!'
# Message delay in milliseconds (be careful when changing this)
message-delay: 1000
# CTCP finger reply
finger-reply: ''
# send a raw message on connect
raw-message-on-connect: false
# the raw message
raw-message: auth name pass
# relay-private-chat - Allow private chat to the bot to relay to the game
relay-private-chat: false
# notify channels or users when a player uses commands
command-notify:
enabled: false
# valid modes: msg, ctcp
mode: msg
# recipients can be channels or users
recipients:
- '#minecraft-test'
- example
ignore:
- /example
# Automatically part invalid channels
part-invalid-channels: false
# Message when leaving invalid channel
part-invalid-channels-message: 'I should not be here! Bye!'
# Channel auto join delay in server ticks (20 ticks = 1 second)
channel-auto-join-delay: 20
# channels - List the channels your bot will join here
channels:
# Channel name must be surrounded by sing quotes to be YAML compliant.
# Use %2E instead of dots in the channel names.
# Example: minecraft%2Etest == minecraft.test
'#minecraft-test':
# worlds we listen to for this channel
worlds:
- '*'
# autojoin - Join the channel automatically on connect
autojoin: true
# modes - Channel modes to set
modes: ''
# password - Channel password
password: ''
# topic - Channel topic
topic: New topic
# topic-protect - Prevent others from changing the topic
topic-protect: false
# Enable chanserve mode for topic set command (/msg chanserv topic #channel <topic>
topic-chanserv: false
# If the Shortify plugin is installed then shoten URLs sent from IRC
shortify: true
# Enable or disable message filtering
enable-filtering: false
# Filters. These wll be removed from IRC to game messages.
filter-list:
- AwesomeBot
# enabled-messages - These are the message types that are either sent to the game or IRC
# config.yml. Remove or comment the messages you don't want.
enabled-messages:
# These messages are sent from game to IRC (see permissions)
- console-chat
- game-action
- game-chat
- game-death
- game-kick
- game-join
- game-quit
- game-mode
# Essentials helpop messages (/helpop /amsg /ac)
- ess-helpop
# Prism
#- prism-rollback
#- prism-drain
#- prism-extinguish
#- prism-custom
# The game-afk message type is not functional yet.
#- game-afk
# These messages are sent from IRC to game (see permissions)
- irc-action
- irc-chat
- irc-pchat
- irc-join
- irc-kick
- irc-part
- irc-topic
- irc-quit
- irc-nickchange
- irc-mode
- irc-notice
#- invalid-irc-commmand
#- irc-console-chat
# Dynmap Web Chat to IRC
- dynmap-web-chat
# IRC to Dynmap Web Chat
- irc-dynmap-web-chat
# IRC acion to Dynmap Chat (/me)
- irc-action-dynmap-web-chat
# mcMMO messages sent to IRC
- mcmmo-admin-chat
- mcmmo-party-chat
- mcmmo-chat
# FactionChat messages sent to IRC
- faction-public-chat
- faction-ally-chat
- faction-enemy-chat
# Hero chat message types that are sent from game to IRC
# Game messages from Global HC channel
- hero-Global-chat
- hero-Global-action
# Game messages from any HC channel
- hero-chat
- hero-action
# Specific HC channel
#- hero-[CHANNEL]-chat
#- hero-[CHANNEL]-action
# Various IRC messages that are sent to Herochat channel. Receiving HC
# channel name is configured per hero-channel: 'CHANNEL NAME'
#- irc-hero-action
#- irc-hero-chat
#- irc-hero-kick
#- irc-hero-join
#- irc-hero-part
#- irc-hero-topic
# CleverNotch bot messages will be sent to the IRC channel
- clever-chat
# OreBroadcast messages
#- ore-broadcast
- titan-chat
- towny-chat
# Specific TownyChat channel or tag
#- towny-[CHANNEL]-chat
#- towny-[CHANNELTAG]-chat
# Specific TitanChat channel
#- titan-[CHANNEL]-chat
# ReportRTS ticket notifications to irc
- rts-notify
# Catch /broadcast messages
#- broadcast-console-message
#- broadcast-message
# RedditStream
#- reddit-messages
# AdminPrivateChat messages
#- game-a-chat
# Hero channel destination for IRC messages
hero-channel: admin
# Towny channel destination for IRC messages
towny-channel: irc
# Log all messages from IRC to HeroChat
log-irc-to-hero-chat: false
# ops - IRC hostname mask styled ops list
ops:
- '*!*sarah@example.com'
# muted - IRC users that should not be heard in game
muted:
- KuShy
# Set ignore-irc-chat to true if you are using @chat and don't want regular IRC chat in your game
ignore-irc-chat: false
# ignore list for custom tab list
custom-tab-ignore-list:
- AwesomeBot
# Hide join message when player is invisible (VanishNoPacket)
hide-join-when-vanished: true
# Hide quit message when player is invisible (VanishNoPacket)
hide-quit-when-vanished: true
# How to respond to an invalid command
invalid-command:
private: false
ctcp: false
# Raw message to send if raw-message-on-join is true
raw-message: ''
raw-message-on-join: false
# join-notice
join-notice:
# Enable or disable this feature.
enabled: false
# Cool down in seconds per user.
cooldown: 60
# If true then message will be sent in private
private: true
# If true then message will be sent via ctcp. if false then normal msg
ctcp: true
# The actual message sent to the user when joining the channel.
# If the message starts with a / then a command will be run and the output sent as the message.
message: '/list'
# commands - A list of commands that the bot will act on
# There are several builtin game_command options.
# @list - list the players in the game
# @help - print out of all of the commands
# @uptime - print the uptime of the game server
# @chat - send message to game
# @hchat - send message to specific hero channel
# @ochat - send message to game (overrides irc-chat)
# @motd - display minecraft server motd
# @msg - send private message to player
# @query - query remote minecraft server
# @rtsmb - Send ReportRTS broadcast message to mods
# @a - Send message to AdminPrivateChat
# The modes can be *, o , v , h, q, s, or i. Mix and match as needed.
# If game_command can optionally accept arguments via %ARGS% and %NAME%
# If a command is private then the result is sent to the player privately.
commands:
chat:
modes: '*'
private: false
ctcp: false
game_command: '@chat'
private_listen: true
channel_listen: true
ochat:
modes: '*'
private: false
ctcp: false
game_command: '@ochat'
private_listen: true
channel_listen: true
h:
modes: '*'
private: false
ctcp: false
game_command: '@hchat'
private_listen: true
channel_listen: true
msg:
modes: '*'
private: true
ctcp: false
game_command: '@msg'
private_listen: true
channel_listen: true
list:
modes: '*'
private: false
ctcp: false
game_command: '@list'
private_listen: true
channel_listen: true
help:
modes: '*'
private: false
ctcp: false
game_command: '@help'
private_listen: true
channel_listen: true
uptime:
modes: '*'
private: false
ctcp: false
game_command: '@uptime'
private_listen: true
channel_listen: true
version:
modes: '*'
private: false
ctcp: false
game_command: version
private_listen: true
channel_listen: true
lag:
modes: '*'
private: false
ctcp: false
game_command: lag
private_listen: true
channel_listen: true
mb:
modes: 'o'
private: 'false'
ctcp: 'false'
game_command: '@rtsmb'
private_listen: 'true'
channel_listen: 'true'
perm: ''
lv:
modes: 'o'
private: 'false'
ctcp: 'false'
game_command: '@list'
extra_commands:
- version
private_listen: 'true'
channel_listen: 'true'
perm: ''
## Uncomment this if you want to hook into AdminPrivateChat
# a:
# modes: '*'
# private: false
# ctcp: false
# game_command: '@a'
# private_listen: true
# channel_listen: true
## Uncomment this to allow gamemode changes via IRC
# gamemode:
# modes: 'o'
# private: false
# ctcp: false
# game_command: 'gamemode %ARGS%'
# private_listen: true
# channel_listen: true