> For the complete documentation index, see [llms.txt](https://tchat.tect.host/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://tchat.tect.host/anti-cap/configuration.md).

# Configuration

## General

```yml
modules:
  # It lets censor, block, or convert words to
  # lowercase when they're typed in all caps
  #
  # Anti cap module loaded from modules/anticap.yml
  anti-cap: true
```

* modules.anti-cap: Enable/disable the module

***

## Module

#### Action

```yml
# Action to take when a message exceeds the cap threshold:
# - ToLowerCase : convert all uppercase letters to lowercase (recommended)
# - BLOCK : cancel the message entirely
# - CENSOR : replace uppercase letters with '*' (or the selected censor-char)
action: "ToLowerCase"
```

* ToLowerCase: Converts all to lowercase; "HELLO" -> "hello".
* BLOCK: Cancels the message.
* CENSOR: Replace the uppercase letters with the 'censor-char' character.

#### Censor-char

```yml
# Character used to replace matched letters (only relevant when action: CENSOR)
censor-char: "*"
```

* The censor character for the 'CENSOR' action.