|
| 1 | +--- |
| 2 | +label: Scoreboard Leaderboards |
| 3 | +description: Publish live in-game scoreboard rankings to Discord, allowing players to track progress and compete through automated leaderboard embeds. |
| 4 | +order: 25 |
| 5 | +author: |
| 6 | + name: Frazer |
| 7 | + avatar: https://avatars.githubusercontent.com/u/136254012?s=96&v=4 |
| 8 | +--- |
| 9 | + |
| 10 | +### What are Scoreboard Leaderboards? |
| 11 | + |
| 12 | +Scoreboard Leaderboards allow you to display a live leaderboard for an in-game **Minecraft scoreboard objective** directly inside a Discord channel. This enables communities to track progress, promote competition, and keep key statistics visible without requiring players to join the Realm to view rankings. |
| 13 | + |
| 14 | +Leaderboards are rendered as Discord embeds and can be configured per scoreboard, per channel. |
| 15 | + |
| 16 | +### How it Works |
| 17 | + |
| 18 | +Scoreboard Leaderboards operate by reading a selected scoreboard objective from your Realm and publishing the results to Discord. |
| 19 | + |
| 20 | +In practice: |
| 21 | +- You select a **Discord channel** where the leaderboard will be posted. |
| 22 | +- You choose the **Minecraft scoreboard** (objective) you want to display. |
| 23 | +- Realm Bot periodically retrieves scoreboard values through the connected Realm environment and updates the embed. |
| 24 | + |
| 25 | +> **Important:** This feature is dependent on the Realm runtime environment. If the required in-game components are not active, leaderboards cannot update. |
| 26 | +
|
| 27 | +### Requirements |
| 28 | + |
| 29 | +Scoreboard Leaderboards require: |
| 30 | + |
| 31 | +- The **Relay Account** to be actively **in-game**. |
| 32 | +- The **Realm Bot Gametest Pack** installed and enabled in the Realm. |
| 33 | +- At least one valid in-game **scoreboard objective** to display. |
| 34 | + |
| 35 | +If any requirement is missing (Relay Account offline, pack disabled, or scoreboard not present), leaderboard updates may fail or show no data. |
| 36 | + |
| 37 | +### How to Set Up |
| 38 | + |
| 39 | +1. Open the **Scoreboard Leaderboards** module in the Realm Bot Dashboard and enable it.<br/> |
| 40 | +  |
| 41 | +2. Select **Create Leaderboard**. |
| 42 | +3. Configure the leaderboard using the creation menu.<br/> |
| 43 | +  |
| 44 | +4. Set the following: |
| 45 | + - **Select channel** - the Discord channel where the leaderboard should be displayed. |
| 46 | + - **Minecraft Scoreboard** - the scoreboard objective to publish. |
| 47 | +5. (Optional) Customise the embed appearance: |
| 48 | + - **Embed Title** - the label shown at the top of the embed. |
| 49 | + - **Embed Color** - the accent color used for the embed. |
| 50 | +6. Save the leaderboard configuration. |
| 51 | + |
| 52 | +Once created, the leaderboard will begin updating in the selected channel when the Relay Account is online and the Gametest Pack is active. |
| 53 | + |
| 54 | +### Recommended Usage |
| 55 | + |
| 56 | +Scoreboard Leaderboards are ideal for: |
| 57 | +- Factions / prisons progression metrics |
| 58 | +- Kills, deaths, K/D tracking (where implemented via scoreboards) |
| 59 | +- Event wins, captures, or objective scoring |
| 60 | +- Currency or point systems tracked via scoreboard objectives |
| 61 | + |
| 62 | +Operational recommendations: |
| 63 | +- Use a dedicated channel such as `#leaderboards`, `#stats`, or `#rankings`. |
| 64 | +- Keep one leaderboard per channel unless you have a structured layout (multiple leaderboards in one channel can become difficult to read). |
| 65 | +- Use clear embed titles aligned with your scoreboard objective name (for example: “Top Kills”, “Top Balance”, “Top Wins”). |
| 66 | + |
| 67 | +### Common Issues |
| 68 | + |
| 69 | +**The leaderboard shows no entries** |
| 70 | +- Confirm the selected scoreboard objective exists in-game and contains values. |
| 71 | +- Ensure the Relay Account is online in the Realm. |
| 72 | +- Verify the Realm Bot Gametest Pack is installed and enabled. |
| 73 | + |
| 74 | +**The leaderboard is not posting to Discord** |
| 75 | +- Confirm the bot has permission to **View Channel**, **Send Messages**, and **Embed Links** in the selected channel. |
| 76 | +- Verify the correct channel was selected during setup. |
| 77 | + |
| 78 | +**The scoreboard name is not appearing in the dropdown** |
| 79 | +- The scoreboard objective may not be created in-game yet, or the environment may not be detectable if the required pack/account is offline. |
| 80 | +- Create or validate the scoreboard in-game, then refresh the dashboard and try again. |
| 81 | + |
| 82 | +### Best Practices |
| 83 | + |
| 84 | +- Treat leaderboard channels as read-only where possible to keep output clean. |
| 85 | +- Standardise scoreboard objective naming in-game to reduce confusion in the dashboard. |
| 86 | +- If you are using leaderboards competitively, ensure your scoreboard values cannot be trivially manipulated by players. |
| 87 | + |
0 commit comments