Configuration
UltraStaffChat's configuration file
config.yml
1
# __ ______ _____ __ ________________ __
2
# / / / / / /__________ _/ ___// /_____ _/ __/ __/ ____/ /_ ____ _/ /_
3
# / / / / / __/ ___/ __ `/\__ \/ __/ __ `/ /_/ /_/ / / __ \/ __ `/ __/
4
# / /_/ / / /_/ / / /_/ /___/ / /_/ /_/ / __/ __/ /___/ / / / /_/ / /_
5
# \____/_/\__/_/ \__,_//____/\__/\__,_/_/ /_/ \____/_/ /_/\__,_/\__/
6
#
7
# UltraStaffChat - config.yml - Main Configuration.
8
# Copyright (C) 2021 Joshua Sing <[email protected]>, Christian F <[email protected]>, SLLCoding <[email protected]>
9
#
10
# This program is free software: you can redistribute it and/or modify
11
# it under the terms of the GNU General Public License as published by
12
# the Free Software Foundation, either version 3 of the License, or
13
# (at your option) any later version.
14
#
15
# This program is distributed in the hope that it will be useful,
16
# but WITHOUT ANY WARRANTY; without even the implied warranty of
17
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18
# GNU General Public License for more details.
19
#
20
# You should have received a copy of the GNU General Public License
21
# along with this program. If not, see <https://www.gnu.org/licenses/>.
22
#
23
# Helpful Links:
24
# Support | https://discord.hypera.dev
25
# Documentation | https://docs.hypera.dev/docs/ultrastaffchat-bungeecord
26
# Source Code | https://github.com/HyperaOfficial/UltraStaffChat
27
28
29
30
# [ UltraStaffChat | General Configuration ]
31
32
# General | No Permission Message
33
no-permission: "&cNo Permission."
34
35
# General | In-game Only Message
36
ingame-only: "&cThis command can only be used in-game."
37
38
39
# [ UltraStaffChat | Discord Configuration ]
40
41
# Discord | Enabled
42
# Should we send messages to Discord?
43
discord-enabled: false
44
45
# Discord | Webhook URL
46
discord-webhook: "https://discord.com/api/webhooks/XXXXXXXXXXXXXXXXXX/XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
47
48
# Discord | Webhook Username
49
# What name do you want the webhook to use?
50
discord-username: "UltraStaffChat"
51
52
# Discord | Webhook Image
53
# What image do you want the webhook to use?
54
discord-image: "https://cdn.discordapp.com/icons/639666139747581955/fa3ffcc73fd3a47054fc575736c812f6.png"
55
56
# Discord | Embed
57
# Should we use embeds?
58
discord-embed: true
59
60
# Discord | StaffChat Format
61
# - Placeholders: Player - {player}, Server - {server}, Message - {message}
62
discord-format:
63
text: "[StaffChat] {server} - **{player}**: {message}" # Only used if 'discord-embed' is disabled.
64
embed: # Only used if 'discord-embed' is enabled.
65
author: # Embed Author
66
name: ""
67
url: ""
68
image: ""
69
title: "" # Embed Title
70
title-url: "" # Enbed Title URL
71
description: "**{player}**: {message}" # Embed Description
72
color: "#5555FF" # Embed Color
73
footer: # Upgrade to UltraStaffChatPro to change the embed Footer
74
image: "" # Embed Image URL
75
thumbnail: "" # Embed Thumbnail URL
76
fields: # Embed Fields (Remove all to have no fields)
77
# 1:
78
# name: "{player}"
79
# value: "{message}"
80
# inline: true
81
# 2:
82
# name: "Server"
83
# value: "{server}"
84
# inline: true
85
# 3:
86
# name: "Example"
87
# value: "You can keep making more fields"
88
# inline: false
89
90
# Discord | Staff Join Messages
91
# Should Staff Join messages be sent to Discord?
92
discord-join-messages: true
93
94
# Discord | Join Format
95
# - Placeholders: Player - {player}, Server - {server}
96
discord-join-format:
97
text: "**{player}** connected to **{server}**" # Only used if 'discord-embed' is disabled.
98
embed: # Only used if 'discord-embed' is enabled.
99
author: # Embed Author
100
name: ""
101
url: ""
102
image: ""
103
title: "{player}" # Embed Title
104
title-url: "" # Enbed Title URL
105
description: "** + {server} **" # Embed Description
106
color: "#5555FF" # Embed Color
107
footer: # Upgrade to UltraStaffChatPro to change the embed Footer
108
image: "" # Embed Image URL
109
thumbnail: "" # Embed Thumbnail URL
110
fields: # Embed Fields (Remove all to have no fields)
111
# 1:
112
# name: "Example"
113
# value: "You can keep making more fields"
114
# inline: false
115
116
# Discord | Staff Leave Messages
117
# Should Staff Leave messages be sent to Discord?
118
discord-leave-messages: true
119
120
# Discord | Leave Format
121
# - Placeholders: Player - {player}, Server - {server}
122
discord-leave-format:
123
text: "**{player}** disconnected from **{server}**" # Only used if 'discord-embed' is disabled.
124
embed: # Only used if 'discord-embed' is enabled.
125
author: # Embed Author
126
name: ""
127
url: ""
128
image: ""
129
title: "{player}" # Embed Title
130
title-url: "" # Enbed Title URL
131
description: "** - {server} **" # Embed Description
132
color: "#5555FF" # Embed Color
133
footer: # Upgrade to UltraStaffChatPro to change the embed Footer
134
image: "" # Embed Image URL
135
thumbnail: "" # Embed Thumbnail URL
136
fields: # Embed Fields (Remove all to have no fields)
137
# 1:
138
# name: "Example"
139
# value: "You can keep making more fields"
140
# inline: false
141
142
# Discord | Staff Switch Messages
143
# Should Staff Switch messages be sent to Discord?
144
discord-switch-messages: true
145
146
# Discord | Switch Format
147
# - Placeholders: Player - {player}, From - {from}, To - {to}
148
discord-switch-format:
149
text: "**{player}** switched from **{from}** -> **{to}**" # Only used if 'discord-embed' is disabled.
150
embed: # Only used if 'discord-embed' is enabled.
151
author: # Embed Author
152
name: ""
153
url: ""
154
image: ""
155
title: "{player}" # Embed Title
156
title-url: "" # Enbed Title URL
157
description: "** {from} -> {to} **" # Embed Description
158
color: "#5555FF" # Embed Color
159
footer: # Upgrade to UltraStaffChatPro to change the embed Footer
160
image: "" # Embed Image URL
161
thumbnail: "" # Embed Thumbnail URL
162
fields: # Embed Fields (Remove all to have no fields)
163
# 1:
164
# name: "Example"
165
# value: "You can keep making more fields"
166
# inline: false
167
168
# Discord | AFK Messages
169
# Should Staff AFK enable messages be sent to Discord?
170
discord-afk-enable-messages: true
171
172
# Discord | AFK Enable Format
173
# - Placeholders: Player - {player}
174
discord-afk-enable-format:
175
text: "**{player}** is now AFK" # Only used if 'discord-embed' is disabled.
176
embed: # Only used if 'discord-embed' is enabled.
177
author: # Embed Author
178
name: ""
179
url: ""
180
image: ""
181
title: "{player}" # Embed Title
182
title-url: "" # Enbed Title URL
183
description: "has gone AFK" # Embed Description
184
color: "#5555FF" # Embed Color
185
footer: # Upgrade to UltraStaffChatPro to change the embed Footer
186
image: "" # Embed Image URL
187
thumbnail: "" # Embed Thumbnail URL
188
fields: # Embed Fields (Remove all to have no fields)
189
# 1:
190
# name: "Example"
191
# value: "You can keep making more fields"
192
# inline: false
193
194
# Discord | AFK Messages
195
# Should Staff AFK disable messages be sent to Discord?
196
discord-afk-disable-messages: true
197
198
# Discord | AFK Disable Format
199
# - Placeholders: Player - {player}
200
discord-afk-disable-format:
201
text: "**{player}** is no longer AFK" # Only used if 'discord-embed' is disabled.
202
embed: # Only used if 'discord-embed' is enabled.
203
author: # Embed Author
204
name: ""
205
url: ""
206
image: ""
207
title: "{player}" # Embed Title
208
title-url: "" # Enbed Title URL
209
description: "is no longer AFK" # Embed Description
210
color: "#5555FF" # Embed Color
211
footer: # Upgrade to UltraStaffChatPro to change the embed Footer
212
image: "" # Embed Image URL
213
thumbnail: "" # Embed Thumbnail URL
214
fields: # Embed Fields (Remove all to have no fields)
215
# 1:
216
# name: "Example"
217
# value: "You can keep making more fields"
218
# inline: false
219
220
221
222
# [ UltraStaffChat | StaffChat Configuration ]
223
224
# StaffChat | Format
225
# - Placeholders: Player - {player}, Server - {server}, Message - {message}
226
staffchat-format: "&8[&4&lStaffChat&8] &4{player}&c: &c{message}"
227
228
# StaffChat | Usage
229
staffchat-usage: "&cUsage: /staffchat <message>"
230
231
# StaffChat | Muted
232
staffchat-muted: "&cStaffChat is currently Muted"
233
234
# StaffChat | Prefix
235
# Allows Staff members to send messages to StaffChat using a prefix before their message.
236
# Set to "" to disable.
237
staffchat-prefix: "#"
238
239
240
241
# [ UltraStaffChat | Toggle Configuration ]
242
243
# Toggle | Enabled
244
toggle-enabled: true
245
246
# Toggle On | Message
247
toggle-message-on: "&8[&4&lStaffChat&8] &cStaffChat Toggled &aOn&c!"
248
249
# Toggle Off | Message
250
toggle-message-off: "&8[&4&lStaffChat&8] &cStaffChat Toggled &cOff&c!"
251
252
# Toggle | Usage
253
toggle-usage: "&cUsage: /sctoggle <state>"
254
255
256
# [ UltraStaffChat | Mute Configuration ]
257
258
# Mute | Enabled
259
mute-enabled: true
260
261
# Mute On | Message
262
mute-message-on: "&8[&4&lStaffChat&8] &cStaffChat &cMuted&c!"
263
264
# Mute Off | Message
265
mute-message-off: "&8[&4&lStaffChat&8] &cStaffChat &aUnmuted&c!"
266
267
# Mute | Usage
268
mute-usage: "&cUsage: /scmute <state>"
269
270
# [ UltraStaffChat | Mute StaffChat Configuration ]
271
272
# Mute | Enabled
273
mute-staffchat-enabled: true
274
275
# Mute On | Message
276
mute-staffchat-message-on: "&8[&4&lStaffChat&8] &cStaffChat has been &cMuted&c!"
277
278
# Mute Off | Message
279
mute-staffchat-message-off: "&8[&4&lStaffChat&8] &cStaffChat has been &aUnmuted&c!"
280
281
# Mute | Usage
282
mute-staffchat-usage: "&cUsage: /mutesc <state>"
283
284
285
286
# [ UltraStaffChat | AFK Configuration ]
287
288
# AFK | Enabled
289
afk-enabled: true
290
291
# AFK | Message
292
# - Placeholders: Player - {player}
293
afk-broadcast: "&7{player} is now &c&lAFK&7."
294
295
# AFK | No longer AFK Message
296
# - Placeholders: Player - {player}
297
no-afk-broadcast: "&7{player} is no longer &c&lAFK&7."
298
299
300
301
# [ UltraStaffChat | Join Message Configuration ]
302
303
# Join Message | Enabled
304
join-enabled: true
305
306
# Join Message | Message
307
# - Placeholders: Player - {player}, Server - {server}
308
join-message: "&7[&a&l+&7] &7[{server}] &a{player}"
309
310
311
312
# [ UltraStaffChat | Leave Message Configuration ]
313
314
# Leave Message | Enabled
315
leave-enabled: true
316
317
# Leave Message | Message
318
# - Placeholders: Player - {player}
319
leave-message: "&7[&c&l-&7] &c{player}"
320
321
322
323
# [ UltraStaffChat | Switch Message Configuration ]
324
325
# Switch Message | Enabled
326
switch-enabled: true
327
328
# Switch Message | Message
329
# - Placeholders: Player - {player}, From - {from}, To - {to}
330
switch-message: "&8[&4&lStaffChat&8] &c{player} switched from {from} to {to}"
331
332
333
334
# [ UltraStaffChat | StaffList Configuration ]
335
336
# StaffList | Enabled
337
stafflist-enabled: true
338
339
# StaffList | Header
340
# - Placeholders: Staff Count - {count}
341
stafflist-header: "&7({count}) &c&lOnline Staff Members&7:"
342
343
# StaffList | Format
344
# - Placeholders: Player - {player}, Server - {server}
345
stafflist-line: "&4{player} &7- &4{server}"
346
347
# StaffList | No staff online
348
stafflist-offline: "&cNo staff members are online."
349
350
351
352
# [ UltraStaffChat | Update Notification Configuration ]
353
354
# Update Notification | Enabled
355
update-enabed: true
356
357
# Update Notification | Message
358
# - Placeholders: New Version - {version}, Current Version - {current}
359
update-message: "&8[&c&lUltraStaffChat&8] &aVersion {version} is now available."
360
361
362
363
# [ UltraStaffChat | Permissions ]
364
365
# Permission | StaffChat Talk
366
permission-talk: "staffchat.talk"
367
368
# Permission | StaffChat Read
369
permission-read: "staffchat.read"
370
371
# Permission | Toggle
372
permission-toggle: "staffchat.toggle"
373
374
# Permission | Mute
375
permission-mute: "staffchat.mute"
376
377
# Permission | Mute Global
378
permission-globalmute: "staffchat.globalmute"
379
380
# Permission | StaffChat Global Mute Bypass
381
permission-bypass: "staffchat.mutebypass"
382
383
# Permission | AFK
384
permission-afk: "staffchat.afk"
385
386
# Permission | Staff Join
387
permission-join: "staffchat.join"
388
389
# Permission | Staff Leave
390
permission-leave: "staffchat.leave"
391
392
# Permission | Switch
393
permission-switch: "staffchat.switch"
394
395
# Permission | Staff List
396
permission-list: "staffchat.list"
397
398
# Permission | Staff (Permission needed to display on Staff List)
399
permission-staff: "staffchat.staff"
400
401
# Permission | Chat Formatting
402
permission-chat-format: "staffchat.format"
403
404
# Permission | Update Notification
405
permission-update: "ultrastaffchat.update"
406
407
# Permission | Configuration Reload
408
permission-reload: "ultrastaffchat.reload"
409
410
# Permission | Debug
411
permission-debug: "ultrastaffchat.debug"
412
413
414
415
# [ UltraStaffChat | System Configuration ]
416
417
# System | Configuration Version
418
# Used for Internal purposes - Don't edit!
419
version: 37
Copied!
Copy link