# Unicode Remover

## About this module

The Unicode Remover module 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)

{% hint style="info" %}
To bypass this module, op or the permission: "**chatsentry.unicoderemover.bypass"** is required.
{% endhint %}

{% hint style="info" %}
If**`process-commands`**is true in config.yml, this module will filter through all commands (of players without bypass permission or op)

If**`process-signs`** is true in config.yml, this module will filter through text written on signs (of players without bypass permission or op)

If**`process-anvils`** is true in config.yml, this module will filter through items renamed in anvils (of players without bypass permission or op)

If**`process-books`** is true in config.yml, this module will filter through writing in books (of players without bypass permission or op)
{% endhint %}

## Config guide

You can access the below settings in the **anti-join-flood.yml** file within the **modules** folder of the plugin's root folder.

{% hint style="success" %}
**Config excerpts taken from v3.6.0 and may not be completely up-to-date with the latest changes. To see the most up-to-date file, see below:**
{% endhint %}

{% content-ref url="/pages/-MOrnM8WU9L8IHPOBbWl" %}
[unicode-remover.yml](/files/files/module-configurations/unicode-remover.yml.md)
{% endcontent-ref %}

###

### enable-compatibility-mode

Certain hacked clients allow players to type in alphanumeric lookalike unicode characters in order to bypass filters. Enabling this will only limit said alphanumeric lookalike unicode characters that are used by hacked clients and text generators to exploit filters while excluding unicode used by other languages.

Disabling this will block all unicode (which may cause issues if people speak other languages than English)

Though it allows for more protection if disabled, having this off may cause conflicts if players speak languages other than English.

```yaml
enable-compatibility-mode: true
```

## filter-commands

Should this module filter commands? Turning this off is useful if you want people to be able to use unicode in commands such as private messaging\
This option does nothing if "process-commands" is false in config.yml

```yaml
filter-commands: true
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://wiki.chatsentry.xyz/config-guides/module-config-guides/unicode-remover.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.