> For the complete documentation index, see [llms.txt](https://wiki.incredibleplugins.com/discordbridge/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://wiki.incredibleplugins.com/discordbridge/modules/linking.md).

# Linking

## Usage

Allows players to link their Minecraft and Discord account.

## Setup

1. Optional: Migrate existing links via `/discordbridge account admin migrate`.
2. If you want to limit who can link their Minecraft accounts, setup allowed roles by executing `/config linking_allowed_roles add <role>` in the Discord server.
3. You can setup roles to be given to linked players in Discord, by executing `/config linking_roles add` in the Discord server. If you add a role, it will be given to existing linked players as well. This might take a while though, since updates are scheduled to improve the experience for large servers. If you remove a role, you need to manually remove this role from its members, if you wish to.
4. You can setup [LuckPerms](https://www.spigotmc.org/resources/luckperms.28140/) groups to be given to linked players in-game, by executing `/config linking_groups add` in the Discord server. If you add a group, it will be given to existing linked players as well. This might take a while though, since updates are scheduled to improve the experience for large servers. If you remove a group, you need to manually remove this group from its members, if you wish to.

### Name Sync Exclude Users

You can exclude users from name sync with the `/config linking_name_sync_ignore_roles add <role>` command in the Discord server. If a user has any of these roles, their name won't be synchronized with the in-game player.

## Ingame Commands

`/discordbridge acccount link`\
Link Discord and Minecraft account.\
\&#xNAN;*Permission: discordbridge.command.account.link*

`/discordbridge acccount unlink`\
Unlink your Discord account.\
\&#xNAN;*Permission: discordbridge.command.account.unlink*

### Administrator Commands

`/discordbridge account admin migrate`\
Migrate linked accounts from another plugin.\
\&#xNAN;*Permission: discordbridge.admin.command.account.admin.migrate*

## PlaceholderAPI Placeholders

Requires [PlaceholderAPI](https://www.spigotmc.org/resources/placeholderapi.6245/) to be installed.

`%discordbridge_module_linking_amount%`\
The amount of players that have linked their accounts.

`%discordbridge_module_linking_user_state_bool%`\
Returns `true` if the player has their account linked and `false`, if their account isn't linked.

`%discordbridge_module_linking_user_state%`\
Whether the account is linked. Returns entry from the locale file.

`%discordbridge_module_linking_user_id%`\
Returns the ID of the linked Discord user.

`%discordbridge_module_linking_user_name%`\
Returns the name of the linked Discord user.

`%discordbridge_module_linking_user_booster%`\
Returns whether user has boosted any server that the bot is added to.

`%discordbridge_module_linking_user_booster_bool%`\
Returns `true` if the player has boosted any server that the bot is added to and `false`, if they didn't boost any server.