# Config options

| Options                         | Explanation                                                                       |
| ------------------------------- | --------------------------------------------------------------------------------- |
| check\_updates                  | Allow plugin to check spigot for updates and announce you.                        |
| relation\_placeholders\_enabled | Enable PlaceholderAPI relation placeholders.                                      |
| timestamp\_format               | Sets the way time is formatted.                                                   |
| boolean                         | Chose what the boolean messages will look like.                                   |
| ops\_use\_group\_format         | If this option is disabled, OP players will need permissions for formats to work. |

| Chat Filter Options | Explanation                                                                                                                                                                                                                                    |
| ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| enabled             | Enable or disable the chat filter option. This is to stop people from using certain words or phrases like swears.                                                                                                                              |
| ignore\_case        | If this option is enabled then the filter will ignore the case for the filtered words.                                                                                                                                                         |
| list                | List the words and phrases that will be filtered and what they will be filtered with. It works like this: `word-to-be-filtered;word-it-will-be-filtered-with` so for example `fuck;***` will replace the word fuck from chat with 3 asterisks. |

| BungeeCord Options     | Explanation                                                                                       |
| ---------------------- | ------------------------------------------------------------------------------------------------- |
| enabled                | Enable bungeecord option. Requires DeluxeChat on BungeeCord and backend servers.                  |
| server\_name           | The server name that will be used for bungeecord.server\_whitelist.                               |
| server\_prefix         | The name of the server that will be displayed when using the placeholder %server% in global chat. |
| join\_global           | If this option is enabled all players will be put in the global chat when they join the server.   |
| use\_server\_whitelist | This option will enable bungeecord.server\_whitelist.                                             |
| server\_whitelist      | List the servers which will have global chat linked to current serve                              |

| Private Messages Options | Explanation                          |
| ------------------------ | ------------------------------------ |
| enable                   | Enable private messaging.            |
| bungeecord               | Enable bungeecord private messaging. |

| Formats Options                      | Explanation                                                                                                   |
| ------------------------------------ | ------------------------------------------------------------------------------------------------------------- |
| priority                             | Selects which format takes over in case of having permission for multiple formats. Lower priority takes over. |
| channel                              | Text that will be shown before prefix.                                                                        |
| prefix                               | Text that will be shown before name.                                                                          |
| name                                 | Text that will be shown before suffix.                                                                        |
| suffix                               | Text that will be shown before the message.                                                                   |
| name\_color                          | Color that the name option will have.                                                                         |
| chat\_color                          | Color that the message sent in chat will have.                                                                |
| channel\_tooltip                     | Text that will be displayed when hovering over the channel in chat.                                           |
| prefix\_tooltip                      | Text that will be displayed when hovering over the prefix in chat.                                            |
| name\_tooltip                        | Text that will be displayed when hovering over the name in chat.                                              |
| suffix\_tooltip                      | Text that will be displayed when hovering over the suffix in chat.                                            |
| channel\_clic&#x6B;*\_*&#x63;ommands | Actions that will be executed when clicking on the channel.                                                   |
| prefix\_clic&#x6B;*\_*&#x63;ommands  | Actions that will be executed when clicking on the prefix.                                                    |
| name\_clic&#x6B;*\_*&#x63;ommands    | Actions that will be executed when clicking on the name.                                                      |
| suffix\_clic&#x6B;*\_*&#x63;ommands  | Actions that will be executed when clicking on the suffix.                                                    |

{% hint style="info" %}
The click commands you can use one of the following actions: \
\[EXECUTE] /command  - Will execute the command when clicked \
\[URL] <https://url-here.com> - Will open the url when clicked
{% endhint %}

{% hint style="info" %}
Some of the options like tooltips and click commands are not required.
{% endhint %}
