# Discord Settings

## Configuration (discord-settings.yml)

### token

Here you have to copy the bot token which you should save in [step 5](https://wiki-en.herrtechniker.eu/bungeesystem/module/setup#step-5-confirm-reset) of the setup.

```yaml
token: ""
```

### state

*state* is the online status of the bot (green, yellow or red circle). The following statuses can be entered here:

* ONLINE
* IDLE
* DO\_NOT\_DISTURB
* INVISIBLE

```yaml
state: "ONLINE"
```

### activity

Enter the type of activity here. The following types can be entered here:

* PLAYING
* LISTENING
* WATCHING
* CUSOM

```yaml
activity: "PLAYING"
```

### content

*content* is the value, i.e. what is displayed after the activity.

```yaml
content: "Minecraft"
```

### guildID

Replace the `-1` here with the ID of your server (Guild)

<figure><img src="https://931426099-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F5DC56OEL1k7OH4aPJLxB%2Fuploads%2F4pHR7DfOdAqwPSNgoEOI%2FGuildID.jpg?alt=media&#x26;token=b7032161-1293-4bd3-909f-37c27bb2416d" alt=""><figcaption></figcaption></figure>

```yaml
guildID: -1
```

### replaceName

If activated, after linking between Discord and Minecraft, the Discord name will be replaced with the name of the Minecraft account.

```yaml
replaceName: false
```

### link

Here you can enter the invitation link to your Discord.

{% hint style="info" %}
If you want the link to be displayed in color in Minecraft chat, simply place the corresponding ColorCodes in front of it.\
ColorCodes are always defined with an `&` character. A list of possible ColorColdes can be found here. Please use the `CHAT CODE` column from the displayed table and replace the `§` sign with the `&` sign.
{% endhint %}

```yaml
link: ""
```

### commands

#### onlinetime

Set enabled `true` if you want to enable the command. With the slashcommand `/onlinetime` you can see the onlinetime from a Minecraft player or a Discord user

```yaml
commands:
  onlinetime:
    enabled: true
    show:
      seconds: true
      minutes: true
      hours: true
      days: true
      years: true
```

### chats

You can allow players to display messages from Minecraft in Discord and from Discord in Minecraft. Only enter the chats that players are allowed to use for this purpose.

Replace the *name* with the name you want the player to see in the command and the channelID with the ID of the Discord chat.

{% hint style="danger" %}
The specified Discord chat has to be a text channel!
{% endhint %}

```yaml
channels:
  countOfChannels: 2
  ingameChatName: "ingame"
  channelList:
    1:
      name: "chat"
      channelID: -1
    2:
      name: "techporn"
      channelID: -1
```

{% hint style="warning" %}
The `Chat` module must be activated in `config.yml` for this!
{% endhint %}

### syncDiscord

The players have the possibility to connect to Discord. To grant this, you only need to add the team groups and the community groups here. Also create roles on the Discord server of your network that are named like the Minecraft groups. Copy the role ID and paste it.

You must also enter the number of team groups and community groups.

{% hint style="warning" %}
The list of groups starts at 1
{% endhint %}

```yaml
syncDiscord:
  countOfTeamGroups: 6
  countOfCommunityGroups: 1
  defaultColor: "&7"
  defaultGroup: "Player"
  # if a player unlink his account, which role will he get
  defaultRoleID: -1
  # replace '-1' with the id of the roles of your Discord Server
  # if you want you can edit the permission for the groups
  # the potency is for the weighting of the roles the smaller the number the higher the rank
  roles:
    community:
      1:
        name: "Premium"
        potency: 7
        color: "&6"
        roleID: -1
        permission: "bungeesystem.discord.premium"
      2:
        name: "Player"
        potency: 8
        color: "&7"
        roleID: -1
        permission: "bungeesystem.discord.player"
    teamGroups:
      1:
        name: "Owner"
        potency: 1
        color: "&4"
        roleID: -1
        permission: "bungeesystem.discord.owner"
      2:
        name: "Admin"
        potency: 2
        color: "&c"
        roleID: -1
        permission: "bungeesystem.discord.admin"
      3:
        name: "Moderator"
        potency: 3
        color: "&1"
        roleID: -1
        permission: "bungeesystem.discord.moderator"
      4:
        name: "Supporter"
        potency: 4
        color: "&9"
        roleID: -1
        permission: "bungeesystem.discord.supporter"
      5:
        name: "Developer"
        potency: 5
        color: "&b"
        roleID: -1
        permission: "bungeesystem.discord.developer"
      6:
        name: "Builder"
        potency: 6
        color: "&4"
        roleID: -1
        permission: "bungeesystem.discord.builder"
```

### Default configuration

```yaml
# to use the discord bot, please create a discord app here https://discord.com/developers/applications
# after that go to "bot" and enable under Privileged Gateway Intents the points "SERVER MEMBERS INTENT", "MESSAGE CONTENT INTENT" and "PRESENCE INTENT"
# furthermore paste your discord token here and invite the bot to your discord server.
#
# If the plugin was started and the module "discord verify" is enabled the bot will be started automatically
token: ""

# available states are ONLINE, IDLE, DO_NOT_DISTURB, INVISIBLE or leave empty for default (online)
state: "ONLINE"

# for example:
# activity: "PLAYING"
# content: "Minecraft"
# available activities are PLAYING, LISTENING, WATCHING or CUSTOM
# by CUSTOM the field content can be empty because only the content of the field 'activity' will be displayed
# or leave empty for no activity
activity: "PLAYING"
content: "Minecraft"

# replace '-1' with the id of the guild of your Discord Server
guildID: -1

# If enabled, the Discord name will be replaced with the Minecraft account name.
replaceName: false

# enter your Discord invite link here
# if you want to show the url in color in the minecraft chat please enter before the url a colorcode
link: ""

commands:
  onlinetime:
    enabled: true
    show:
      seconds: true
      minutes: true
      hours: true
      days: true
      years: true

# you can choose which channel are available to write between discord and Minecraft
# it would be advantageous if no images were allowed to be broadcast in these channels.
# !!the name of the channel has to be in lower case!!
# syntax:
# name: "name of the channel"
# channelID: -1
channels:
  countOfChannels: 2
  ingameChatName: "ingame"
  channelList:
    1:
      name: "chat"
      channelID: -1
    2:
      name: "techporn"
      channelID: -1

syncDiscord:
  countOfTeamGroups: 6
  countOfCommunityGroups: 1
  defaultColor: "&7"
  defaultGroup: "Player"
  # if a player unlink his account, which role will he get
  defaultRoleID: -1
  # replace '-1' with the id of the roles of your Discord Server
  # if you want you can edit the permission for the groups
  # the potency is for the weighting of the roles the smaller the number the higher the rank
  roles:
    community:
      1:
        name: "Premium"
        potency: 7
        color: "&6"
        roleID: -1
        permission: "bungeesystem.discord.premium"
      2:
        name: "Player"
        potency: 8
        color: "&7"
        roleID: -1
        permission: "bungeesystem.discord.player"
    teamGroups:
      1:
        name: "Owner"
        potency: 1
        color: "&4"
        roleID: -1
        permission: "bungeesystem.discord.owner"
      2:
        name: "Admin"
        potency: 2
        color: "&c"
        roleID: -1
        permission: "bungeesystem.discord.admin"
      3:
        name: "Moderator"
        potency: 3
        color: "&1"
        roleID: -1
        permission: "bungeesystem.discord.moderator"
      4:
        name: "Supporter"
        potency: 4
        color: "&9"
        roleID: -1
        permission: "bungeesystem.discord.supporter"
      5:
        name: "Developer"
        potency: 5
        color: "&b"
        roleID: -1
        permission: "bungeesystem.discord.developer"
      6:
        name: "Builder"
        potency: 6
        color: "&4"
        roleID: -1
        permission: "bungeesystem.discord.builder"
```

## Commands

### Syntax

| Command                  | Description                                                                                  |
| ------------------------ | -------------------------------------------------------------------------------------------- |
| /discord                 | Receive the invitation link to the Discord server                                            |
| /link \<UserID/Username> | <p>Enter your UserID or your username (not nickname)<br><a href="#username">see here</a></p> |
| /verify \<code>          | Enter the verification code sent to you by the Discord bot to end the linking process        |
| /unlink                  | Disconnect the connection with your Discord account                                          |
| /chat \<chatname>        | Write from Minecraft to Discord and the other way too                                        |

## Username

<figure><img src="https://931426099-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F5DC56OEL1k7OH4aPJLxB%2Fuploads%2F5aPaXqjrcSZPMInLrTxp%2FNutzername.JPG?alt=media&#x26;token=e410547b-94ff-4afa-851c-87f5fc002b0b" alt=""><figcaption><p>What is the username</p></figcaption></figure>