config.yml
1
2
3
# ____ _ _ ____ _
4
# / ___| | |__ __ _ | |_ / ___| ___ _ __ | |_ _ __ _ _
5
# | | | '_ \ / _` | | __| \___ \ / _ \ | '_ \ | __| | '__| | | | |
6
# | |___ | | | | | (_| | | |_ ___) | | __/ | | | | | |_ | | | |_| |
7
# \____| |_| |_| \__,_| \__| |____/ \___| |_| |_| \__| |_| \__, |
8
# |___/
9
10
# For guides & detailed information, see the wiki: https://wiki.chatsentry.xyz
11
# For permissions and commands, see https://wiki.chatsentry.xyz/pac/
12
13
# Run '/kcs reload' to update changes made to config files
14
15
16
17
# --------------------------------------------------------------------------------------
18
# Core Settings
19
# --------------------------------------------------------------------------------------
20
21
# Should ChatSentry notify operators (and players with the permission "chatsentry.admin") when new plugin updates are available?
22
# Keeping this on is highly recommended as otherwise you won't be able to take advantage of new features and fixes as quickly!
23
check-for-updates: true
24
25
# Where should ChatSentry's modules filter?
26
process-chat: true
27
process-commands: true
28
29
# Should ChatSentry's applicable modules filter through writing on signs, renaming items in anvils, and writing in books?
30
# Currently the modules directly supporting these options are the Word & Phrase Filter, Link & Ad Blocker, and the Unicode Remover
31
process-signs: true
32
process-anvils: true
33
process-books: true
34
35
# Context prediction aims to increase positive detections and decrease false positive detections through acting as a safenet for supported modules with logic that dynamically adjusts thresholds and settings real-time to react more precisely based on predicted context of messages. Adjustments are temporary and bound to specific messages only.
36
context-prediction: true
37
38
# Should ChatSentry disable Minecraft's built in "Kicked for spamming" / "disconnect.spam" kick?
39
# It's recommended to keep this enabled to give the auto punisher full punishment priority. If you don't plan to use the auto punisher, you may want to turn this off
40
disable-vanilla-spam-kick: true
41
42
# Experimental: Using BungeeCord or Velocity? ChatSentry offers various cross-server synchronization options below.
43
# For information on how to set up the plugin to work with BungeeCord or Velocity, see the guide here: https://wiki.chatsentry.xyz/network-bridge-setup-guide
44
# The below settings are global and non-exclusive to this instance. Any changes made here will be applied to all other ChatSentry configs on your network.
45
network:
46
enable: false
47
sync-configs: true
48
global-admin-notifier-messages: true
49
50
51
# --------------------------------------------------------------------------------------
52
# Modules
53
# --------------------------------------------------------------------------------------
54
55
# Below you can enable the modules you'd like to use. Go in to the modules individual config files to adjust their settings
56
57
58
# Admin Notifier
59
# Notifies admins real-time when a module is triggered with detailed information, allowing them to know when to take action if necessary.
60
enable-admin-notifier: false
61
62
63
# Discord Notifier
64
# Sends Discord notifications via webhooks when modules flag a message or action, players are manually or automatically warned, warnings are pardoned, autowarns expire, and when the Auto Punisher punishes a player
65
enable-discord-notifier: false
66
67
68
# Intelligent Auto Punisher
69
# Automatically runs punishment commands on players who excessively trigger modules within a defined time frame.
70
enable-auto-punisher: false
71
72
73
# Intelligent Word & Phrase Filter
74
# Hyper intelligently detects swears configured blocked words or phrases (and words/phrases similar to those on the list) from being said in chat, commands, signs, anvils, and books (additional check contexts can be disabled).
75
enable-word-and-phrase-filter: false
76
77
78
# Intelligent Link & Ad Blocker
79
# Prevents web links & server advertising (regular server ips & numeric server ips) with optional extra sensitivity bypass detection in chat, commands, signs, anvils, and books (additional check contexts can be disabled). Includes the ability to whitelist domains or all subdomains of a domain.
80
enable-link-and-ad-blocker: false
81
82
83
# Intelligent Spam Blocker
84
# Accurately blocks spammy messages by examining their word, character, and sequence diversity in comparison to the messages length. Additionally prevents players from repeating the same or similar messages over and over within a short period of time with a dynamically adjusting repeat cooldown
85
enable-spam-blocker: false
86
87
88
# Intelligent Chat Cooldown
89
# Controls how quickly players can send messages and configured or all commands within a defined time frame.
90
enable-chat-cooldown: false
91
92
93
# Intelligent Anti Chat Flood
94
# Prevents or intelligently modifies the use of excessive repeated characters and very long "words" without interfering with players using 'expressive' chat.
95
enable-anti-chat-flood: false
96
97
98
# Unicode Remover
99
# Removes non US-ASCII (US keyboard) characters in chat messages and commands to prevent alphanumeric lookalike unicode characters from being used to bypass filters & modules. Has the option to use a compatibility mode that only blocks unicode used by hacked clients - blocking virtually all alphanumeric lookalike unicode supported by MC while allowing other languages in chat, commands, signs, anvils, and books (additional check contexts can be disabled)
100
enable-unicode-remover: false
101
102
103
# Intelligent Cap Limiter
104
# Limits the use of excessive capital letters in messages without interference of messages using proper grammar. Can auto-set the message to lowercase or blocks it entirely. Player names are ignored.
105
enable-cap-limiter: false
106
107
108
# Intelligent Anti Parrot
109
# Prevents players using hacked clients to automatically copy ("parrot") other players chat messages. Also prevents the same (non-generic) message from be said by multiple players within a short time frame. Able to detect bots/players appending random sequences of numbers and other characters to their messages to try and evade the filter.
110
enable-anti-parrot: false
111
112
113
# Intelligent Chat Executor
114
# Modifies and or performs actions triggered by defined messages/commands using simple or complex matching techniques. Optionally supports execution of sign text and anvil renames.
115
enable-chat-executor: false
116
117
118
# Anti Statue Spambot
119
# Prevents joining players abilities to send messages or commands until they move in order to protect against basic artificially controlled spam bots. Has an optional command whitelist.
120
# Does not require "process-commands" in the main config to be enabled to function.
121
enable-anti-statue-spambot: false
122
123
124
# Anti Relog Spam
125
# Prevents players excessively relogging in short periods of time to flood chat. Uses a dynamically increasing cooldown to effectively combat excessive relogging without affecting players who are relogging reasonably.
126
enable-anti-relog-spam: false
127
128
129
# Anti Join Flood
130
# Prevents more than a defined amount of players joining every minute to prevent bot join flooding to lag, spam, & or crash the server.
131
enable-anti-join-flood: false
132
133
134
# Anti Command Prefix
135
# Prevents players using prefixed commands to get around filters and discover potential sensitive server information like the plugins. Ex. /minecraft:me instead of /me. Optionally integrates with the Command Spy module; when a command is modified/a prefix is removed, it will appear crossed out in the command spy notification.
136
# Does not require "process-commands" in the main config to be enabled to function.
137
enable-anti-command-prefix: false
138
139
140
# Auto Grammar
141
# Converts players' messages to use proper capitalization, periods, and correct typos in chat and configured or all commands.
142
enable-auto-grammar: false
143
144
145
# Command Spy
146
# Shows players real-time commands to admins. Commands can optionally be whitelisted or blacklisted.
147
# Does not require "process-commands" in the main config to be enabled to function.
148
enable-command-spy: false
149
150
151
# --------------------------------------------------------------------------------------
152
# Logging
153
# --------------------------------------------------------------------------------------
154
155
# Should messages flagged by modules be logged for future reference?
156
# This is required to be enabled in order to make use of the lookup command
157
enable-violations-log: true
158
159
# Below is which module triggers will be logged. Disregarded if the above option is not enabled
160
enable-logging-for:
161
chat-cooldown: false
162
link-and-ad-blocker: true
163
word-and-phrase-filter: true
164
spam-blocker: true
165
unicode-remover: true
166
cap-limiter: true
167
anti-parrot: true
168
anti-chat-flood: true
169
anti-statue-spambot: false
170
chat-executor: true
171
172
# The plugin will periodically attempt to erase log data older than the below value in days in effort to save database space
173
# NOTE: a full server restart is required for changes to this option to take effect
174
# Set to -1 to disable automatic cleaning
175
clean-logs-older-than: 30
176
177
178
# --------------------------------------------------------------------------------------
179
# Permission Overrides
180
# --------------------------------------------------------------------------------------
181
182
# You can disable the functionality of particular module/restrictions' bypass permissions and force modules to apply themselves to players even with bypass permissions or op by enabling the overrides below
183
# It's recommended you do this per-player/group with permissions by simply negating/disabling the bypass permission for modules/restrictions you'd like to apply to them if they have the bypass all permission
184
# This option is mainly useful for testing purposes if you don't want to have to deop yourself for testing
185
override-bypass-permissions:
186
chat-cooldown: false
187
link-and-ad-blocker: false
188
word-and-phrase-filter: false
189
spam-blocker: false
190
unicode-remover: false
191
cap-limiter: false
192
anti-parrot: false
193
anti-chat-flood: false
194
anti-statue-spambot: false
195
anti-join-flood: false
196
chat-executor: false
197
auto-grammar: false
198
anti-command-prefix: false
199
command-spy: false
200
201
202
# --------------------------------------------------------------------------------------
203
# Server Lockdown
204
# --------------------------------------------------------------------------------------
205
206
# You can use /cslockdown to toggle a persistent through server restart lock on the server which can either block unseen before/unknown players from joining, or everybody except those who are on the below exemption list
207
# This command was designed to be used under the case of a bot attack to disallow the unseen before player-bots entering the server, but it can be used for other purposes as well
208
# Kick messages can be found in lang.yml
209
210
lockdown:
211
active: false
212
# Valid modes: 'only-known', 'only-exempt'
213
current-mode: "only-known"
214
exempt-usernames:
215
- "Notch"
216
- "jeb_"
Copied!
Last modified 5mo ago
Copy link