Skip to content

Commit 7e9aa33

Browse files
committed
Updated Getting Started on the Docs
1 parent 2f946e8 commit 7e9aa33

3 files changed

Lines changed: 105 additions & 23 deletions

File tree

images/getting-started-step-1.png

87.3 KB
Loading

images/getting-started-step-2.png

80.6 KB
Loading

setup.md

Lines changed: 105 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,121 @@
11
---
22
label: Getting Started
3+
description: Connect your Minecraft Bedrock Realm to Discord in three steps: link your Microsoft account, run the connect command, then configure modules and settings.
34
order: 101
45
icon: rocket
56
authors:
67
- name: Kaii
7-
avatar: https://avatars.githubusercontent.com/u/72093371?s=96&v=4
8+
avatar: https://avatars.githubusercontent.com/u/72093371?s=96&v=4
9+
- name: Frazer
10+
avatar: https://avatars.githubusercontent.com/u/136254012?s=96&v=4
811
---
912

10-
1113
# Getting Started
1214

13-
(insert image of setup process here)
15+
This guide walks you through the official setup flow to connect your Minecraft Bedrock Realm to Discord using Realm Bot. The onboarding process is designed to be completed in a few minutes and is separated into three stages:
16+
17+
1. **Link Microsoft Account**
18+
2. **Run Discord Command**
19+
3. **Configure Settings**
20+
21+
![Setup Flow Overview](/images/getting-started-step-1.png)
22+
23+
---
24+
25+
## Before You Begin
26+
27+
### 1) Invite Realm Bot to Your Discord Server
28+
Realm Bot must be present in your Discord server before you can run the connection command.
29+
30+
- Use the `/invite` command **or** invite via: https://realmbot.dev/invite
31+
- Grant the required permissions. **Administrator** is recommended for full functionality.
32+
33+
> **Important:** If Realm Bot cannot post messages or cannot read channels where you plan to use features (logs, chat relay, leaderboards), setup may succeed but modules will not operate correctly.
34+
35+
### 2) Ensure You Have the Correct Access
36+
You should be:
37+
- The Realm Owner, or a trusted administrator with access to manage the Realm
38+
- A Discord administrator (or equivalent) in the server you are connecting
39+
40+
---
41+
42+
## Step 1 - Link Your Microsoft Account
43+
44+
Realms are owned and managed through a Microsoft/Xbox account. Realm Bot requires you to link a Microsoft account so it can detect and manage your available Realms.
45+
46+
1. Go to the dashboard: https://dashboard.realmbot.dev
47+
2. Sign in with Discord.
48+
3. Select **Connect Microsoft Account** to link your Microsoft/Xbox account.
49+
50+
![Connect Microsoft Account](/images/getting-started-step-1.png)
51+
52+
> **Security Note:** Only link an account you trust to administrate the Realm. Treat account linking as privileged access.
53+
54+
---
55+
56+
## Step 2 - Run the Discord Connection Command
57+
58+
After your Microsoft account is linked, the next step is to connect that account to the correct Discord server.
59+
60+
1. Open the Discord server you want to connect.
61+
2. Run the following command in any channel where Realm Bot can respond:
62+
63+
`/connect`
64+
65+
![Run Discord Command](/images/getting-started-step-2.png)
66+
67+
### What `/connect` Does
68+
- Verifies your linked Microsoft account
69+
- Associates the current Discord server with your Realm management context
70+
- Enables the dashboard to load and configure Realm-specific settings and modules
71+
72+
> **Tip:** If you manage multiple servers, ensure you run `/connect` in the correct server first. You can repeat the process per server if needed.
73+
74+
---
75+
76+
## Step 3 - Configure Your Realm Settings
1477

15-
Follow these steps to set up Realm Bot for your server.
78+
Once your connection is established, you can configure your Realm using the dashboard and the relevant module pages.
1679

17-
## 1. Invite the Bot
18-
Use the `/invite` command or [click here](https://realmbot.dev/invite) to invite Realm Bot to your Discord server.
19-
Ensure you grant the required permissions (Administrator is recommended for full functionality).
80+
Recommended configuration sequence:
2081

21-
## 2. Link Your Account
22-
Realms are owned by Xbox Live accounts. You must link your Xbox account to Realm Bot so it can access your Realms.
23-
1. Go to the [Dashboard](https://dashboard.realmbot.dev).
24-
2. Login with Discord.
25-
3. Link your Microsoft/Xbox account.
82+
1. **Choose your Realm** (if prompted)
83+
2. Review **Bot Join Settings** (how the relay/bot connects)
84+
3. Configure **Gametest Pack Management** (only if required by your modules)
85+
4. Enable and configure any **Realm Modules** you plan to use:
86+
- Chat Relay
87+
- Realm Console
88+
- Bot Detection
89+
- Member Gate
90+
- Leveling
91+
- Scoreboard Leaderboards
92+
- (Optional) Tebex Integration
2693

27-
## 3. Connect to Discord
28-
Once your account is linked on the dashboard, run the connect command in your Discord server:
29-
- **Command**: `/connect`
30-
- **Action**: This will verify your linked account and connect the current Discord server to your Xbox profile.
31-
- **Result**: You should see a success message listing your available Realms.
94+
You can also view command help in Discord at any time:
95+
- `/help`
96+
97+
---
98+
99+
## Common Issues
100+
101+
### “I can’t see my Realms in the dashboard.”
102+
- Confirm you linked the correct Microsoft/Xbox account.
103+
- Ensure the account actually owns (or has access to) the Realms you expect.
104+
- Re-open the dashboard and refresh after linking.
105+
106+
### `/connect` does nothing or fails.
107+
Check the following:
108+
- Realm Bot is invited to the server and is online.
109+
- You are running `/connect` in a server channel where the bot has permission to respond.
110+
- Your role has sufficient permissions to run management commands (server admin recommended).
111+
112+
### Xbox/Microsoft privacy blocks linking or access.
113+
If linking or Realm access fails, review your Xbox privacy settings to ensure external services can function correctly.
114+
115+
> **Important:** Privacy settings can prevent applications from accessing required profile/realm data. If issues persist, adjust the relevant Xbox privacy options and retry linking.
116+
117+
---
32118

33-
## 4. Configuration
34-
You can now use the `/realm` commands to manage your Realm!
35-
- View commands: `/help`
36-
- Configure settings: [Web Dashboard](https://dashboard.realmbot.dev)
119+
## Next Steps
37120

38-
> [!IMPORTANT]
39-
> If you encounter issues connecting, ensure your Xbox Privacy Settings allow external apps/bots.
121+
Once setup is complete, proceed to the **Overview** page to learn

0 commit comments

Comments
 (0)