Skip to content

Chat Filter ​

Plugin ID: cn.hayashiume.chatfilterConfig file: [Empostor.Plugins.ChatFilter]Config.json

ReferenceWhere
ConfigurationConfig.json
CommandsNone
Admin PanelChat Filter tab
HTTP APINone

Blocks words and rate-limits spam in game chat. Two independent filters — a message can be caught by either.

Configuration ​

Edit [Empostor.Plugins.ChatFilter]Config.json in the server working directory. Fields are flat (no wrapper object).

json
{
  "Enabled": false,
  "BlockedWords": [],
  "BlockMessage": true,
  "SpamThreshold": 5,
  "SpamWindowSeconds": 10
}
FieldTypeDefaultDescription
EnabledboolfalseMaster switch for both filters.
BlockedWordsstring[][]Blocked words. Case-insensitive substring match — "bad" also blocks "badword".
BlockMessagebooltruetrue cancels the message; false lets it through and only logs a warning.
SpamThresholdint5Messages allowed inside the window before rate limiting kicks in.
SpamWindowSecondsint10Sliding window length in seconds.

Substring matching

Short words like "ass" match "pass" and "classic". Use specific, longer words to avoid false positives.

Filter Rules ​

FilterTriggerAction
Word filterMessage contains any BlockedWords entryHandled per BlockMessage
Spam filterSpamThreshold or more messages within SpamWindowSecondsHandled per BlockMessage

Example ​

Block two words and allow at most 3 messages per 5 seconds:

json
{
  "Enabled": true,
  "BlockedWords": ["badword1", "badword2"],
  "BlockMessage": true,
  "SpamThreshold": 3,
  "SpamWindowSeconds": 5
}

Admin Panel ​

Chat Filter tab — manage at runtime without restarting or editing files:

ControlEffect
Enable/disable checkboxToggles filtering
Word list editorAdds or removes blocked words
Threshold & window fieldsSpam rate-limit tuning
Block / log toggleSets BlockMessage behaviour

Panel changes are runtime-only

Settings changed in the panel take effect immediately but are not written back to the config file. Persist your choices in [Empostor.Plugins.ChatFilter]Config.json yourself.

  • Chat Manager — message length limits; complements this plugin.
  • Commands — full list of in-game commands.