Skip to content

Commit 119ff35

Browse files
committed
Added Server Account Linking Page to the Docs
1 parent 64c3421 commit 119ff35

2 files changed

Lines changed: 118 additions & 0 deletions

File tree

Lines changed: 118 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,118 @@
1+
---
2+
label: Account Linking
3+
description: Configure how members link their Minecraft account to Discord, including automatic role assignment, optional nickname syncing, auto-invites to selected Realms, and join log reporting.
4+
order: 97
5+
authors:
6+
- name: Frazer
7+
avatar: https://avatars.githubusercontent.com/u/136254012?s=96&v=4
8+
---
9+
10+
# Account Linking
11+
12+
Account Linking allows members to associate their **Minecraft (Microsoft/Xbox)** identity with their **Discord** account. Once enabled, Realm Bot can automate common onboarding tasks such as **role assignment** and **Realm invitations**, while providing clear audit logs for staff.
13+
14+
![Account Linking Configuration](/images/server-account-linking.png)
15+
16+
---
17+
18+
## What Account Linking is for
19+
20+
Account Linking is designed to help you:
21+
22+
- Verify that a Discord member controls the Minecraft account they claim
23+
- Automatically grant roles when a member successfully links
24+
- Optionally sync Discord nicknames to match Minecraft usernames
25+
- Automatically invite linked users to one or more connected Realms
26+
- Log linking events to a dedicated channel for transparency
27+
28+
---
29+
30+
## User Settings
31+
32+
These settings control whether linking is enabled and how it behaves for users.
33+
34+
### Account Linking
35+
When enabled, members can link their Minecraft account to Discord using the Realm Bot linking flow.
36+
37+
**Recommended:** Enable this for most communities, especially public or semi-public servers, as it supports verification and automation.
38+
39+
### Change Nickname
40+
When enabled, Realm Bot will update a user’s **Discord nickname** to match their Minecraft username after linking.
41+
42+
**Before enabling, ensure:**
43+
- Realm Bot has **Manage Nicknames** permission in your Discord server
44+
- Realm Bot’s role is **above** the roles of users whose nicknames it needs to edit (Discord role hierarchy)
45+
- Your server rules allow nickname automation (some communities prefer members to control nicknames themselves)
46+
47+
> **Note:** If permissions or role hierarchy prevent nickname changes, linking can still succeed, but nickname syncing may fail.
48+
49+
---
50+
51+
## Server Integration
52+
53+
These settings define what happens *after* an account is linked.
54+
55+
### Linked Account Roles
56+
Select one or more Discord roles to automatically assign when a member successfully links.
57+
58+
Common uses:
59+
- Grant access to member-only channels after verification
60+
- Separate verified players from unverified users
61+
- Apply moderation or gameplay roles tied to account ownership
62+
63+
**Best practice:** Assign only the minimum role(s) needed for access. Keep staff roles manual.
64+
65+
### Auto-invite to Realms
66+
Choose which connected Realm(s) should automatically invite users when they link their account.
67+
68+
This is ideal for:
69+
- Whitelisted Realms
70+
- Member-only Realms
71+
- Servers that want a “link → join instantly” onboarding flow
72+
73+
**Operational notes:**
74+
- Auto-invite should be limited to trusted Realms (avoid auto-inviting to testing/admin Realms).
75+
- If a Realm is missing from the dropdown, confirm it is connected and visible under your linked Xbox account context.
76+
77+
### Join Logs Channel
78+
Select a Discord channel where Realm Bot will post account linking events (e.g., successful links, key outcomes, and related system messages as supported).
79+
80+
**Recommended setup:**
81+
- Use a staff-only channel (e.g., `#join-logs` or `#verification-logs`)
82+
- Ensure Realm Bot has:
83+
- **View Channel**
84+
- **Send Messages**
85+
- **Read Message History** (recommended)
86+
87+
---
88+
89+
## Recommended Configuration
90+
91+
For most servers, this is the cleanest configuration:
92+
93+
1. Enable **Account Linking**
94+
2. Set **Linked Account Roles** to a standard member role (e.g., `Member` / `Verified`)
95+
3. Enable **Auto-invite to Realms** only for your primary public/member Realm
96+
4. Set a dedicated **Join Logs Channel**
97+
5. Enable **Change Nickname** only if your staff team wants enforced identity consistency
98+
99+
---
100+
101+
## Troubleshooting
102+
103+
### Roles are not being assigned
104+
- Confirm the selected role exists and is still selected.
105+
- Ensure Realm Bot’s role is **above** the target role(s) in Discord role hierarchy.
106+
- Verify Realm Bot has **Manage Roles** permission.
107+
108+
### Nicknames are not changing
109+
- Ensure **Change Nickname** is enabled.
110+
- Ensure Realm Bot has **Manage Nicknames** permission.
111+
- Check role hierarchy: Realm Bot must be above the member’s highest role.
112+
113+
### Auto-invite is not sending invites
114+
- Confirm the Realm is selected under **Auto-invite to Realms**.
115+
- Verify the Realm is connected and available under the linked Xbox account context.
116+
- If your Realm has strict membership limits, ensure you have capacity for new invites.
117+
118+
---

images/server-account-linking.png

78.9 KB
Loading

0 commit comments

Comments
 (0)