Setting configurations

MCSF settings.yml Documentation

The settings.yml file is an important configuration file for MCSF plugin. It allows you to customize various settings related to chat filtering, language preferences, debug options, punishments, and more. This document provides an in-depth explanation of each setting and its purpose.

Example Default settings.yml File

locale: en
default-filter-setting: false
forcefully-enable-filter: false
checks:
  replacement: '*'
  enable-client-chat-filtering: true
  enable-async-player-chat-event-filtering: true
  enable-book-filtering: true
  enable-discord-chat-filtering: true
  customRegex:
    enable-client-custom-regex-filtering: true
  fullWordCheck:
    enable-full-word-check: true
    enable-full-word-punishments: false
  patternCheck:
    enable-pattern-check: true
    enable-pattern-punishments: false
  similarityCheck:
    enable-similarity-check: true
    enable-similarity-punishments: false
  maximum-similarity: 0.85
  globalCheck:
    enable-global-check: false
    enable-global-punishments: false
    disabling-filtering-disables-global-check: false
    enabled-global-checks:
    - FullWordCheck
    - PatternCheck
    - SimilarityCheck
debug:
  disabled-debug-paths:
  - Enter debug file names into here to disable them.
punishments:
  punishment-commands:
  - 2:tell %s stop swearing please!
  - 5:kick %s stop swearing!
  - 10:ban %s you swear too much..
  reset-flags-after-amount: 10
  should-flags-be-incremental: false
  cancel-event-if-punished: true
  check-new-book-content: true
  check-new-sign-content: true
  check-player-message-content: true
command_info:
  cooldown-time: 5
hooks:
  discordSRV:
    enable-discord-hook: false
    wrap-swears-in-spoilers: true
    only-use-pattern-check: true

Configuration Options

Here's an explanation of each configuration option in the settings.yml file:

• locale: Specifies the language/locale used by the plugin. Default value: en.
• default-filter-setting: Specifies the default filter setting when a player joins the server. Default value: false.
• forcefully-enable-filter: Forces the filter to be enabled regardless of individual player preferences. Default value: false.

Check Settings

The checks section configures various filter checks and their settings:

• replacement: Specifies the replacement character for filtered words. Default value: *.
• enable-client-chat-filtering: Enables client chat filtering. Default value: true.
• enable-async-player-chat-event-filtering: Enables async player chat event filtering. Default value: true.
• enable-book-filtering: Enables book content filtering. Default value: true.
• enable-discord-chat-filtering: Enables Discord chat filtering. Default value: true.

Custom Regex Check

The customRegex section configures custom regex filtering:

• enable-client-custom-regex-filtering: Enables custom regex filtering for client messages. Default value: true.

Full Word Check

The fullWordCheck section configures full word filtering:

• enable-full-word-check: Enables full word filtering. Default value: true.
• enable-full-word-punishments: Enables punishments for full word filtering. Default value: false.

Pattern Check

The patternCheck section configures pattern-based filtering:

• enable-pattern-check: Enables pattern-based filtering. Default value: true.
• enable-pattern-punishments: Enables punishments for pattern-based filtering. Default value: false.

Similarity Check

The similarityCheck section configures similarity-based filtering:

• enable-similarity-check: Enables similarity-based filtering. Default value: true.
• enable-similarity-punishments: Enables punishments for similarity-based filtering. Default value: false.
• maximum-similarity: Specifies the maximum similarity threshold for filtering. Default value: 0.85.

Global Check

The globalCheck section configures global filtering:

• enable-global-check: Enables global filtering. Default value: false.
• enable-global-punishments: Enables punishments for global filtering. Default value: false.
• disabling-filtering-disables-global-check: Determines if disabling filtering also disables global check. Default value: false.
• enabled-global-checks: Specifies the enabled global checks. Default value: FullWordCheck, PatternCheck, SimilarityCheck.

Debug Settings

The debug section configures debug options:

• disabled-debug-paths: Lists the debug file names to be disabled.

Punishment Settings

The punishments section configures punishment options:

• punishment-commands: Specifies the punishment commands with their respective thresholds.
• reset-flags-after-amount: Specifies the flag reset threshold.
• should-flags-be-incremental: Determines if flags should be incremental. Default value: false.
• cancel-event-if-punished: Determines if the event should be cancelled if the player is punished. Default value: true.
• check-new-book-content: Determines if new book content should be checked. Default value: true.
• check-new-sign-content: Determines if new sign content should be checked. Default value: true.
• check-player-message-content: Determines if player message content should be checked. Default value: true.

Command Settings

The command_info section configures command-related settings:

• cooldown-time: Specifies the cooldown time for commands. Default value: 5.

Hooks

The hooks section configures plugin hooks:

• discordSRV: Configures DiscordSRV integration options.
  • enable-discord-hook: Determines if the Discord hook should be enabled. Default value: false.
  • wrap-swears-in-spoilers: Determines if swears should be wrapped in spoilers on Discord. Default value: true.
  • only-use-pattern-check: Determines if only pattern check should be used for Discord messages. Default value: true.

That covers the documentation for the settings.yml file of MCSF plugin. Make sure to modify the values according to your specific requirements.