# Configuration

## Options

### Enabled

Enable or disable the full banned words module

## Banned Words list

```yaml
# List of banned words
bannedWords:
  - Arse
  - Ass
  - Asshole
  - Aternos
```

This is the list of banned words, you can add or remove words to this list, it is not necessary to use quotation marks

## Whitelist

```yaml
whitelist:
  - tecthost
```

All words in the whitelist will be ignored by the banned words system, for example, if you block "test" and type "test12", the plugin will detect "test" and block it, but if you add "test12" in the whitelist, it will not block it

## Type

```yaml
# Types:
# - BLOCK - Blocks the message
# - CENSOR - Censors the message
type: "CENSOR"
```

* BLOCK: Blocks the message
* CENSOR: Censors the message (replace the banned word with "\*" character)

## Actions

### Message

```yaml
# Message displayed to players when they type a blocked word
blockedMessage:
  - "&8--------- { &#c03afeT&#a72cf8C&#8e1ff1h&#7411eba&#5b03e4t &8} ---------"
  - "    &cYou can't send this word!"
  - "       &cBlocked word: {word}"
  - "&8---------------------------"
```

Sends a multi-line message

### Title

```yaml
# Title displayed to players when they type a blocked word
title:
  # Enable/disable the title
  enabled: true
  # Title
  title: "✶ &#fe0000Y&#f50101o&#ec0202u &#e20202c&#d90303a&#d00404n&#c70505'&#bd0606t &#b40707w&#ab0707r&#a20808i&#980909t&#8f0a0ae &#860b0bt&#7d0b0bh&#730c0ca&#6a0d0dt &f✶"
  # Subtitle
  subtitle: "&#A5A5A5Blocked word: {word}"
```

* Enabled: Enable/disable the title and subtitle
* Title: The text of the title
* Subtitle: The text of the subtitle

### Actionbar

```yaml
# Action bar displayed to players when they type a blocked word
actionbar:
  # Enable/disable the title
  enabled: true
  # Action bar text
  bar: "&7[&#c03afeT&#a72cf8C&#8e1ff1h&#7411eba&#5b03e4t&7] &#fe0000Y&#f50101o&#ec0202u &#e20202c&#d90303a&#d00404n&#c70505'&#bd0606t &#b40707w&#ab0707r&#a20808i&#980909t&#8f0a0ae &#860b0bt&#7d0b0bh&#730c0ca&#6a0d0dt"
```

* Enabled: Enable/disable the actionbar
* Bar: The action bar text

### Sound

```yaml
# Sound executed to players when they type a blocked word
sound:
  # Enable/disable the title
  enabled: true
  # Sound
  # https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Sound.html
  sound: "ENTITY_VILLAGER_NO"
```

* Enabled: Enable/disable the sound
* Sound: The sound name, full list [here](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Sound.html)

### Particles

```yaml
particles:
  # Enable/disable particles
  enabled: false
  # https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Particle.html
  particle: ANGRY_VILLAGER
  # Number of particles
  particles: 4
```

* Enabled: Enable/disable the particles
* Particle: The particle name, full list [here](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Particle.html)
* Particles: The number of particles

### Bypass Permissions

```yaml
bypass:
  # Permission for bypass banned words system
  permission: "tchat.bypass.banned_words"
```

Here you can modify the permissions to bypass all the banned words

## Discord hook

```yaml
# Discord module
discord:
  # Enable/disable the module
  enabled: false
  # Discord webhook
  webhook: "https://discord.com/channels/..."
```

* **Enabled:** Enable/disable the discord module for Banned Words
* **Webhook:** The discord webhook