βš™
Main configuration
UltraStaffChatPro's primary configuration file
config.yml
1
# __ ______ _____ __ ________________ __ ____
2
# / / / / / /__________ _/ ___// /_____ _/ __/ __/ ____/ /_ ____ _/ /_/ __ \_________
3
# / / / / / __/ ___/ __ `/\__ \/ __/ __ `/ /_/ /_/ / / __ \/ __ `/ __/ /_/ / ___/ __ \
4
# / /_/ / / /_/ / / /_/ /___/ / /_/ /_/ / __/ __/ /___/ / / / /_/ / /_/ ____/ / / /_/ /
5
# \____/_/\__/_/ \__,_//____/\__/\__,_/_/ /_/ \____/_/ /_/\__,_/\__/_/ /_/ \____/
6
#
7
# UltraStaffChatPro v2.0.0 - config.yml - Main configuration file
8
# Copyright (c) 2021-present Joshua Sing <[email protected]>. All Rights Reserved.
9
#
10
# Helpful Links
11
# - Support | https://discord.hypera.dev
12
# - Documentation | https://docs.hypera.dev/docs/ultrastaffchatpro
13
#
14
# User placeholders
15
# - {player} | Player's username
16
# - {uuid} | Player's unique id
17
# - {server} | Player server's name (Proxy only)
18
# - {afk} | Player AFK status
19
# - {playtime} | Player's online time
20
# - {playtime_server} | Player's server online time (Resets when they switch server)
21
#
22
# User integration placeholders
23
# - LuckPerms | {lp_prefix}, {lp_group}, {lp_group_display}, {lp_suffix}, {lp_<meta-key>}
24
# - Ultra Permissions | {up_prefix}, {up_suffix}
25
# - PremiumVanish | {vanish}
26
# - RedisBungee | {proxy_id}
27
#
28
# RGB Support
29
# - RGB Format | `&#aabbcc` (eg. `&#2155cc`)
30
#
31
​
32
# [ UltraStaffChatPro | General Configuration ]
33
general:
34
​
35
# General | Default console placeholders
36
console:
37
​
38
# Placeholder | Name
39
name: "Console"
40
​
41
# Placeholder | Unique ID (UUID)
42
uuid: "f78a4d8d-d51b-4b39-98a3-230f2de0c670"
43
​
44
# Placeholder | Server
45
server: "Global"
46
​
47
# General | Unknown server name
48
unknown-server: "Unknown"
49
​
50
# General | Server display names (Proxy only)
51
server-display:
52
# Original name : Display name
53
lobby: "Lobby"
54
survival: "SMP"
55
​
56
# General | Disabled servers (Proxy only)
57
disabled-servers:
58
- "auth"
59
​
60
​
61
​
62
# [ UltraStaffChatPro | Placeholder Configuration ]
63
placeholders:
64
​
65
# Placeholder | Vanish
66
# This allows you to change the value of the {vanish} placeholder.
67
# This only works with the PremiumVanish integration.
68
vanish:
69
vanished: "&7Vanished | "
70
not-vanished: ""
71
​
72
# Placeholder | AFK
73
afk:
74
afked: "&c&lAFK &7| "
75
not-afk: ""
76
​
77
# Placeholder | Playtime
78
# Used for {playtime} and {playtime_server}
79
# Format placeholders: {hours}, {minutes}, {seconds}
80
# {hours_total}, {minutes_total}, {seconds_total}
81
playtime:
82
enabled: true
83
format: "{hours}h, {minutes}m, {seconds}s"
84
​
85
​
86
​
87
# [ UltraStaffChatPro | Discord Configuration ]
88
discord:
89
​
90
# Discord | Enabled
91
enabled: false
92
​
93
# Discord | Mode
94
# Options: "BOT", "WEBHOOK"
95
mode: "BOT"
96
​
97
# Discord | Bot Configuration
98
# Only used if 'mode' is set to "BOT"
99
bot:
100
​
101
# Bot | Token
102
token: "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
103
​
104
# Bot | Discord guild ID
105
guild: "XXXXXXXXXXXXXXXXXX"
106
​
107
# Bot | Discord channel ID
108
channel: "XXXXXXXXXXXXXXXXXX"
109
​
110
# Bot | Status
111
# Options: "ONLINE", "IDLE", "DO_NOT_DISTURB", "INVISIBLE"
112
status: "ONLINE"
113
​
114
# Bot | Activity
115
activity:
116
​
117
# Activity | Enabled
118
enabled: true
119
​
120
# Activity | Type
121
# Options: "DEFAULT" (Playing), "WATCHING", "LISTENING"
122
type: "WATCHING"
123
​
124
# Activity | Message
125
# Placeholders: {online} (Total online players), {count} (Total online staff / People with the StaffList display permission)
126
message: "{online} players on play.example.net"
127
​
128
# Discord | Webhook Configuration
129
# Only needed if 'mode' is set to "WEBHOOK"
130
# Note: Two-way chat requires the use of a bot.
131
webhook:
132
​
133
# Webhook | Avatar
134
# Placeholders: {player}, {uuid}
135
avatar: "https://crafatar.com/avatars/{uuid}.png"
136
​
137
# Webhook | Username
138
username: "{player}"
139
​
140
# Webhook | URL
141
url: "https://discord.com/api/webhooks/XXXXXXXXXXXXXXXXXX/XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
142
​
143
# Discord | Display
144
display:
145
​
146
# Display | Name
147
# How should Discord users display in-game?
148
# Options: "TAG" (Name#1234), "NAME" (Nickname), "USERNAME" (Username)
149
name: "TAG"
150
​
151
# Display | Server
152
# What should the {server} placeholder be
153
# replaced with for people talking from Discord?
154
server: "Discord"
155
​
156
# Discord | Allowed Mentions
157
# Options: "ALL" (@everyone, @here, users, roles), "ROLES" (users, roles), "USERS" (users), "NONE"
158
allowed-mentions: "NONE"
159
​
160
​
161
# [ UltraStaffChatPro | StaffChat Configuration ]
162
staffchat:
163
​
164
# StaffChat | Prefix
165
prefix:
166
​
167
# Prefix | Enabled
168
enabled: true
169
​
170
# Prefix | Chat message prefix
171
prefix: "#"
172
​
173
# StaffChat | Toggle
174
toggle:
175
enabled: true
176
​
177
# StaffChat | Mute
178
mute:
179
enabled: true
180
hide-events: false # Should join/switch/leave messages also be hidden?
181
​
182
# StaffChat | Global Mute
183
global-mute:
184
enabled: true
185
​
186
# StaffChat | AFK
187
afk:
188
enabled: true
189
auto-unafk: true # Should the user be marked as not afk if they send a message in staff chat?
190
​
191
# StaffChat | Join messages
192
join:
193
enabled: true
194
​
195
# StaffChat | Switch messages
196
switch:
197
enabled: true
198
​
199
# StaffChat | Leave messages
200
leave:
201
enabled: true
202
​
203
# StaffChat | Formatting codes
204
# Should players be able to use formatting codes in messages?
205
formatting:
206
enabled: true
207
​
208
# StaffChat | Console
209
console:
210
​
211
# StaffChat | Should console receive staffchat messages?
212
receive-messages: true
213
​
214
# StaffChat | Should console bypass `/scmute`?
215
bypass-mute: true
216
​
217
​
218
​
219
# [ UltraStaffChatPro | StaffList Configuration ]
220
stafflist:
221
​
222
# StaffList | Enabled
223
enabled: true
224
​
225
# StaffList | Hide vanished players
226
# Requires PremiumVanish
227
hide-vanished: true
228
​
229
# StaffList | Sorting
230
sorting:
231
​
232
# StaffList Sorting | Mode
233
# Options:
234
# - GROUP | Sorts the StaffList by groups, ordering the groups by how they are listed.
235
# Placeholders: {group_display}
236
# - SERVER | Sorts the StaffList by server name, from A-Z (Proxy only)
237
# - USERNAME | Sorts the StaffList by username, from A-Z
238
# - DISABLED | Disables sorting, users will be added to the StaffList as returned by the server
239
mode: "GROUP"
240
​
241
# StaffList Sorting | Groups
242
# This is only used if `mode` is set to "GROUP"
243
groups:
244
owner:
245
display: "&cOwners"
246
permission: "staffchat.group.owner"
247
admin:
248
display: "&4Administrators"
249
permission: "staffchat.group.admin"
250
moderator:
251
display: "&cModerators"
252
permission: "staffchat.group.moderator"
253
helper:
254
display: "&eHelpers"
255
permission: "staffchat.group.helper"
256
​
257
​
258
​
259
# [ UltraStaffChatPro | MultiChannel Configuration ]
260
multichannel:
261
​
262
# MultiChannel | Enabled
263
enabled: true
264
​
265
# MultiChannel | Channels
266
channels:
267
​
268
# Helper Chat (Example channel)
269
# This key is used as the main command for the channel.
270
helperchat:
271
​
272
# MultiChannel | Command aliases
273
# Set to [] to disable all aliases. Remove line to remove alias.
274
aliases:
275
chat:
276
- "hc"
277
- "helperstaffchat"
278
toggle:
279
- "hctoggle"
280
mute:
281
- "hcmute"
282
global-mute:
283
- "mutehc"
284
- "hcglobalmute"
285
​
286
# MultiChannel | Prefix
287
prefix:
288
​
289
# Prefix | Enabled
290
enabled: true
291
​
292
# Prefix | Chat message prefix
293
prefix: "%"
294
​
295
# MultiChannel | Messages
296
messages:
297
​
298
# Message | Format
299
# Placeholders: {message}
300
format: "&7[&e&lH&7] &e{player}&7: &c{message}"
301
​
302
# Message | No permission
303
no-permission: "&cNo permission."
304
​
305
# Message | Command usage
306
usage: "&cUsage: /hc <message>"
307
​
308
# MultiChannel | Toggle
309
toggle:
310
enabled: true
311
messages:
312
toggled-on: "&7[&e&lH&7] &aToggled on."
313
toggled-off: "&7[&e&lH&7] &cToggled off."
314
​
315
# MultiChannel | Mute
316
mute:
317
enabled: true
318
hide-events: false
319
messages:
320
muted: "&7[&e&lH&7] &cMuted."
321
unmuted: "&7[&e&lH&7] &aUnmuted."
322
​
323
# MultiChannel | Global Mute
324
global-mute:
325
enabled: true
326
messages:
327
blocked: "&cHelperChat is currently muted."
328
muted: "&7[&e&lH&7] &cHelperChat was muted by {player}"
329
unmuted: "&7[&e&lH&7] &aHelperChat was unmuted by {player}"
330
​
331
# MultiChannel | Join messages
332
join:
333
enabled: true
334
message: "&7[&e&lH&7] &e{player} &7joined"
335
​
336
# MultiChannel | Switch messages
337
# Placeholders: {from}, {to}
338
switch:
339
enabled: true
340
message: "&7[&e&lH&7] &e{player} &7switched from &c{from} &7to &a{to}"
341
​
342
# MultiChannel | Leave messages
343
leave:
344
enabled: true
345
message: "&7[&e&lH&7] &e{player} &7left"
346
​
347
# MultiChannel | Formatting codes
348
# Should players be able to use formatting codes in messages?
349
formatting:
350
enabled: true
351
​
352
# MultiChannel | Console
353
console:
354
​
355
# MultiChannel | Should console receive messages?
356
receive-messages: true
357
​
358
# MultiChannel | Should console bypass `/hcmute`?
359
bypass-mute: true
360
​
361
# MultiChannel | Discord
362
# This is only used if the Discord integration is enabled.
363
discord:
364
​
365
# Discord | Enabled
366
# Should the Discord integration be used for this channel?
367
enabled: false
368
​
369
# Discord | Guild ID (Server ID)
370
guild: "XXXXXXXXXXXXXXXXXX"
371
​
372
# Discord | Channel ID
373
channel: "XXXXXXXXXXXXXXXXXX"
374
​
375
# Discord | Webhook configuration
376
# This is only used if the Discord integration is configured to use a webhook.
377
webhook:
378
​
379
# Webhook | Avatar
380
# Placeholders: {player}, {uuid}
381
avatar: "https://crafatar.com/avatars/{uuid}.png"
382
​
383
# Webhook | Username
384
username: "{player}"
385
​
386
# Webhook | URL
387
url: "https://discord.com/api/webhooks/XXXXXXXXXXXXXXXXXX/XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
388
​
389
# Discord | MultiChannel message format
390
message:
391
# Discord | Mode
392
# Options: "EMBED", "TEXT"
393
mode: "EMBED"
394
​
395
# Discord | Embed
396
# Only needed if 'mode' is set to "EMBED"
397
embed:
398
author:
399
name: "{player}"
400
url: ""
401
image: "https://crafatar.com/avatars/{uuid}.png"
402
title:
403
text: ""
404
url: ""
405
description: "{message}"
406
color: "#55FFFF"
407
footer:
408
text: "UltraStaffChatPro"
409
icon: ""
410
image: ""
411
thumbnail: ""
412
fields: # You can comment out all fields to disable them.
413
# 1:
414
# name: "Field 1"
415
# value: "Test"
416
# inline: true
417
# 2:
418
# name: "Field 2"
419
# value: "Test"
420
# inline: true
421
​
422
# Discord | Text
423
# Only needed if 'mode' is set to "TEXT"
424
text: "**{player}**: {message}"
425
​
426
# Discord | MultiChannel join message
427
join:
428
# Discord | Mode
429
# Options: "EMBED", "TEXT"
430
mode: "EMBED"
431
​
432
# Discord | Embed
433
# Only needed if 'mode' is set to "EMBED"
434
embed:
435
author:
436
name: "{player}"
437
url: ""
438
image: "https://crafatar.com/avatars/{uuid}.png"
439
title:
440
text: ""
441
url: ""
442
description: "{player} joined the server"
443
color: "#55FFFF"
444
footer:
445
text: "UltraStaffChatPro"
446
icon: ""
447
image: ""
448
thumbnail: ""
449
fields: # You can comment out all fields to disable them.
450
# 1:
451
# name: "Field 1"
452
# value: "Test"
453
# inline: true
454
# 2:
455
# name: "Field 2"
456
# value: "Test"
457
# inline: true
458
​
459
# Discord | Text
460
# Only needed if 'mode' is set to "TEXT"
461
text: "[**+**] {player}"
462
​
463
# Discord | MultiChannel switch message
464
# Placeholders: {from}, {to}
465
switch:
466
# Discord | Mode
467
# Options: "EMBED", "TEXT"
468
mode: "EMBED"
469
​
470
# Discord | Embed
471
# Only needed if 'mode' is set to "EMBED"
472
embed:
473
author:
474
name: "{player}"
475
url: ""
476
image: "https://crafatar.com/avatars/{uuid}.png"
477
title:
478
text: ""
479
url: ""
480
description: "{player} switched from {from} to {to}"
481
color: "#55FFFF"
482
footer:
483
text: "UltraStaffChatPro"
484
icon: ""
485
image: ""
486
thumbnail: ""
487
fields: # You can comment out all fields to disable them.
488
# 1:
489
# name: "Field 1"
490
# value: "Test"
491
# inline: true
492
# 2:
493
# name: "Field 2"
494
# value: "Test"
495
# inline: true
496
​
497
# Discord | Text
498
# Only needed if 'mode' is set to "TEXT"
499
# Placeholders: {from}, {to}
500
text: "{player} switched from {from} to {to}"
501
​
502
# Discord | MultiChannel leave message
503
leave:
504
# Discord | Mode
505
# Options: "EMBED", "TEXT"
506
mode: "EMBED"
507
​
508
# Discord | Embed
509
# Only needed if 'mode' is set to "EMBED"
510
embed:
511
author:
512
name: "{player}"
513
url: ""
514
image: "https://crafatar.com/avatars/{uuid}.png"
515
title:
516
text: ""
517
url: ""
518
description: "{player} left the server"
519
color: "#55FFFF"
520
footer:
521
text: "UltraStaffChatPro"
522
icon: ""
523
image: ""
524
thumbnail: ""
525
fields: # You can comment out all fields to disable them.
526
# 1:
527
# name: "Field 1"
528
# value: "Test"
529
# inline: true
530
# 2:
531
# name: "Field 2"
532
# value: "Test"
533
# inline: true
534
​
535
# Discord | Text
536
# Only needed if 'mode' is set to "TEXT"
537
text: "[**-**] {player}"
538
​
539
# Discord | MultiChannel global mute message
540
global-mute:
541
​
542
# Discord | MultiChannel global mute ON message
543
muted:
544
# Discord | Mode
545
# Options: "EMBED", "TEXT"
546
mode: "EMBED"
547
​
548
# Discord | Embed
549
# Only needed if 'mode' is set to "EMBED"
550
embed:
551
author:
552
name: "{player}"
553
url: ""
554
image: "https://crafatar.com/avatars/{uuid}.png"
555
title:
556
text: ""
557
url: ""
558
description: "{player} has globally muted helperchat"
559
color: "#55FFFF"
560
footer:
561
text: "UltraStaffChatPro"
562
icon: ""
563
image: ""
564
thumbnail: ""
565
fields: # You can comment out all fields to disable them.
566
# 1:
567
# name: "Field 1"
568
# value: "Test"
569
# inline: true
570
# 2:
571
# name: "Field 2"
572
# value: "Test"
573
# inline: true
574
​
575
# Discord | Text
576
# Only needed if 'mode' is set to "TEXT"
577
text: "{player} has globally muted helperchat"
578
​
579
# Discord | MultiChannel global mute OFF message
580
unmuted:
581
# Discord | Mode
582
# Options: "EMBED", "TEXT"
583
mode: "EMBED"
584
​
585
# Discord | Embed
586
# Only needed if 'mode' is set to "EMBED"
587
embed:
588
author:
589
name: "{player}"
590
url: ""
591
image: "https://crafatar.com/avatars/{uuid}.png"
592
title:
593
text: ""
594
url: ""
595
description: "{player} has globally unmuted helperchat"
596
color: "#55FFFF"
597
footer:
598
text: "UltraStaffChatPro"
599
icon: ""
600
image: ""
601
thumbnail: ""
602
fields: # You can comment out all fields to disable them.
603
# 1:
604
# name: "Field 1"
605
# value: "Test"
606
# inline: true
607
# 2:
608
# name: "Field 2"
609
# value: "Test"
610
# inline: true
611
​
612
# Discord | Text
613
# Only needed if 'mode' is set to "TEXT"
614
text: "{player} has globally unmuted helperchat"
615
​
616
# MultiChannel | Permissions
617
permissions:
618
talk: "helperchat.talk"
619
read: "helperchat.read"
620
toggle: "helperchat.toggle"
621
mute: "helperchat.mute"
622
global-mute:
623
toggle: "helperchat.global-mute"
624
bypass: "helperchat.global-mute.bypass"
625
read: "helperchat.global-mute.read" # Permission required to receive global mute message.
626
join:
627
send: "helperchat.join"
628
read: "helperchat.join.read"
629
switch:
630
send: "helperchat.switch"
631
read: "helperchat.switch.read"
632
leave:
633
send: "helperchat.leave"
634
read: "helperchat.leave.read"
635
​
636
​
637
# [ UltraStaffChatPro | Permission Configuration ]
638
permission:
639
​
640
# Permission | StaffChat
641
staffchat:
642
talk: "staffchat.talk"
643
read: "staffchat.read"
644
toggle: "staffchat.toggle"
645
mute: "staffchat.mute"
646
global-mute:
647
toggle: "staffchat.global-mute"
648
bypass: "staffchat.global-mute.bypass"
649
read: "staffchat.global-mute.read" # Permission required to receive the global mute broadcast.
650
​
651
# Permission | StaffList
652
stafflist:
653
view: "staffchat.list.view"
654
view-vanished: "staffchat.list.view-vanished"
655
display: "staffchat.list"
656
​
657
# Permission | Events
658
event:
659
afk:
660
send: "staffchat.afk"
661
read: "staffchat.afk.read"
662
join:
663
send: "staffchat.join"
664
read: "staffchat.join.read"
665
switch:
666
send: "staffchat.switch"
667
read: "staffchat.switch.read"
668
leave:
669
send: "staffchat.leave"
670
read: "staffchat.leave.read"
671
​
672
# Permission | UltraStaffChatPro
673
ultrastaffchatpro:
674
update: "ultrastaffchatpro.update" # Permission required to receive update notifications.
675
reload: "ultrastaffchatpro.reload"
676
debug: "ultrastaffchatpro.debug"
677
​
678
​
679
​
680
# [ UltraStaffChatPro | Command Configuration ]
681
​
682
# Command | Aliases
683
aliases:
684
​
685
# Aliases | StaffChat (/staffchat)
686
staffchat:
687
- "sc"
688
- "staffc"
689
- "schat"
690
​
691
# Aliases | StaffChat Toggle (/sctoggle)
692
sctoggle:
693
- "staffchattoggle"
694
​
695
# Aliases | StaffChat Mute (/scmute)
696
scmute:
697
- "staffchatmute"
698
​
699
# Aliases | StaffChat Global Mute (/mutesc)
700
mutesc:
701
- "scglobalmute"
702
​
703
# Aliases | StaffChat AFK (/scafk)
704
scafk:
705
- "staffchatafk"
706
​
707
# Aliases | StaffList (/stafflist)
708
stafflist:
709
- "staff"
710
​
711
​
712
​
713
# [ UltraStaffChatPro | Advanced Configuration ]
714
advanced:
715
​
716
# Advanced | Update Notifications enabled
717
# This is recommended if you want to keep USCP up-to-date!
718
update-notifications: true
719
​
720
​
721
​
722
# [ UltraStaffChatPro | System Configuration ]
723
​
724
# System | Configuration file version
725
# Used for making sure this file is up-to-date. - Do not change this!
726
version: 12
727
​
728
​
729
# - You're done!
730
# Thank you for purchasing and using UltraStaffChatPro!
731
# If you have any ideas for UltraStaffChatPro, please suggest them at https://feedback.hypera.dev/
Copied!
Copy link