> For the complete documentation index, see [llms.txt](https://wiki-en.herrtechniker.eu/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://wiki-en.herrtechniker.eu/bungeesystem/module/discord-bot/config.yml.md).

# config.yml

## Konfiguration (config.yml)

### Prefix

The prefix is exchanged in the message files with `%prefix%` (placeholder). If you run the command and enter the placeholder at the beginning of the message, it will be replaced with the prefix. This can be changed in the `config.yml`.

```yaml
prefix: "&5Discord &8|&r"
```

### Permission

To be able to execute the command for the Discord Bot Verify module, you need the permission that is entered in `config.yml`.

```yaml
permission: "bungeesystem.discordverify.use"
```

### usingWebhook

If you have selected a Discord channel via the `Chat` module, there are 2 options for transmitting the message to the Discord channel.\
Option 1: Via a webhook\
Option 2: Via the DiscordBot

Wenn usingWebhook aktiviert ist, wird die Möglichkeit 1 genommen.

```yaml
usingWebhook: true
```

### usingEmbedForWebhook

If this is activated, the message is transmitted in an embed via the webhook. If the setting is deactivated, the message is transmitted as a normal Discord message.

{% hint style="info" %}
The design of the embed can be changed in the message files.
{% endhint %}

```yaml
# should be the message in an embed (for the webhook).
usingEmbedForWebhook: false
```

### switchChat

Offer your players on your server the possibility to change the chat in Minecraft to read messages on Discord and the other way around.

```yaml
switchChat: true
```

### ignoreAttachments

If activated, the system checks whether the message sent in a Discord channel that can be selected via the chat module contains an image or a video. If this is the case, it will be ignored and the player who selected the channel will not receive a message. If disabled and this happens as described above, the player will receive a message instead of the image or video that an image/video has been sent and that he should open Discord if he wants to see it.

```yaml
# if enabled all attachments will be ignored.
# If disabled the player will get a message that a user send a video or an image that can not be displayed in the minecraft chat.
ignoreAttachments: false
```

### syncTime

The syncTime (synchronization time) indicates the interval at which the system checks whether a new player has been verified.

{% hint style="info" %}
The time is entered in seconds.
{% endhint %}

```yaml
syncTime: 600
```

### syncMessage

Here you can set whether the player receives a notification when synchronization is complete.

```yaml
syncMessage: false
```

### repeatSyncTime

The repeatSyncTime is a method that checks whether the player still has the same rights as on Discord. If not, these are updated.

{% hint style="info" %}
The repeatSyncTime is specified
{% endhint %}

```yaml
repeatSyncTime: 1200
```

### aliases

You can also define so-called aliases that you can enter instead of /link, /unlink, /verify or /discord. To do this, simply add further points under the item `aliases`.

```yaml
aliases:
  link: []
  unlink: []
  verify: []
  discord: []
```

## Default configuration

```yaml
discord:
  prefix: "&5Discord &8|&r"
  # permission to execute '/link <user id>'-command and '/verify <code>'-command
  permission: "bungeesystem.discordverify.use"
  # using webhook for the chat messages in discord instead of the bot. The message from the bot is everytime as an embed (recommed)
  usingWebhook: true
  # should be the message in an embed (for the webhook).
  usingEmbedForWebhook: false
  # if enabled and the module chat also then the Discord channels are added to the channels of the chat module
  switchChat: false
  # if enabled all attachments will be ignored.
  # If disabled the player will get a message that a user send a video or an image that can not be displayed in the minecraft chat.
  ignoreAttachments: false
  # set a time which effect the synchronisation between minecraft and discord.
  # That means every x seconds the system will look if their a new player that linked minecraft with discord and it will sync roles and other stuff.
  # sync time in seconds (default = 600 seconds => 10 minutes)
  syncTime: 600
  # When the synchronisation is finished, should the player receive a message or not (true = the player receives a message)
  syncMessage: false
  # set a time which effect the synchronisation between minecraft and discord.
  # That means every x seconds the system checks if the player still has the same permissions.
  # If not, the rank is removed from Discord and reassigned to the rank the player has in Minecraft.
  # sync time in seconds (default = 1200 seconds => 20 minutes)
  repeatSyncTime: 1200
  aliases:
    link: []
    unlink: []
    verify: []
    discord: []
```