> For the complete documentation index, see [llms.txt](https://wxrs.gitbook.io/wxrs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://wxrs.gitbook.io/wxrs/serverlinked-1.21-26.1.1-v1.1.md).

# ServerLinked - 1.21 - 26.1.1 (v1.1)

Add links to your server's pause menu!

**ServerLinked** is a lightweight connectivity plugin that utilizes the native **Minecraft 1.21+ ServerLinks API.** ServerLinked bridges the gap between your server and your community by integrating official links directly into the native **Game Menu (Pause Screen)**.

<a href="https://discord.gg/3te5ypDG8h" class="button primary" data-icon="discord">Support Discord</a>

<details>

<summary>Downloads</summary>

Download from [Spigot](https://www.spigotmc.org/resources/serverlinked-%E2%9A%A1-advanced-server-links-easy-setup.134131/) <i class="fa-faucet-drip" style="color:$warning;">:faucet-drip:</i>

</details>

## Features

* ✅ **1.21 Native Support:** Uses the official Minecraft 1.21 API so your links show up directly in the ESC/Pause menu.
* 🎨 **Full Hex & Gradients:** With MiniMessage integrated, you can use hex colors and gradients in any of the system message.
* 🌍 **Translated for 10+ Languages:** Translations provided for **English, German, Spanish, French, Hindi, Italian, Portuguese, Russian, Vietnamese, and Chinese.** You can add your own languages using the template [here](https://wxrs.gitbook.io/wxrs/serverlinked-1.21-26.1.1#adding-language-files).
* 🔗 **Social Commands:** When a new link is added, you can automatically create a command for it such as `/discord` or `/store` .
* 🚀 **Lightweight:** Written to have as little effect on your server’s TPS as possible.
* 🌌 **Hover Text:** You can add custom descriptions that appear when a player hovers over a link in chat.
* 📊 **Click Tracking:** Includes a simple stats system to track how many clicks your links are getting.
* 📢 **Timed Announcements:** Built-in link broadcaster that can cycle through your links.

{% columns %}
{% column %}

<figure><img src="https://1787459436-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FnqeyMdchT7AKX8rj2Icl%2Fuploads%2FjkZk3Hw9SSP4cJ1qfew5%2FPauseMenu.gif?alt=media&amp;token=8f02abb6-6c62-471d-871e-4ed052519d22" alt=""><figcaption></figcaption></figure>
{% endcolumn %}

{% column %}

<figure><img src="https://1787459436-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FnqeyMdchT7AKX8rj2Icl%2Fuploads%2FbckLhUxUpVgtUO6IV2Hm%2FLinks.gif?alt=media&amp;token=aef411e1-482a-423c-8024-79a3d74b023b" alt=""><figcaption></figcaption></figure>
{% endcolumn %}
{% endcolumns %}

{% columns %}
{% column %}

<figure><img src="https://1787459436-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FnqeyMdchT7AKX8rj2Icl%2Fuploads%2Fa1zPj2udsK32el4Z9dHw%2FAddLink.gif?alt=media&amp;token=cd54a0b6-b4a0-46a1-bfd8-576fed363fc3" alt=""><figcaption></figcaption></figure>
{% endcolumn %}

{% column %}

<figure><img src="https://1787459436-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FnqeyMdchT7AKX8rj2Icl%2Fuploads%2FWPWcKh4DCGfaRuTYU2BV%2FStats.gif?alt=media&amp;token=9f33f359-b6d1-4c0a-9f81-a1867cf08c1f" alt=""><figcaption></figcaption></figure>
{% endcolumn %}
{% endcolumns %}

## Commands & Permissions

#### Commands

You may use **/serverlinked** or **/sl** as an alias.

* **/links**
* **/sl help**
* **/sl reload**
* **/sl add \<id> \<name> \<url> \<true|false>**
* **/sl remove \<id>**
* **/sl stats**
* **/sl stats reset \<confirm>**

**\<id>** will become the command to retrieve the link (eg., /discord).\
**\<true|false>** defines if you want the link to have a command or not.

#### Permissions

* **serverlinked.links** - allows access to /links
* **serverlinked.help** - allows access to /sl help
* **serverlinked.reload** - allows access to /sl reload
* **serverlinked.add** - allows access to /sl add \<id> \<name> \<true|false>
* **serverlinked.remove** - allows access to /sl remove \<id>
* **serverlinked.stats** - allows viewing link statistics
* **serverlinked.stats.reset** - allows resetting statistics

## Notice

Due to the technical limitations of the Minecraft 1.21+ API, updates to the Server Links menu (pause screen) are not instantaneous. Players must leave and rejoin to see the changes. However, commands (eg., /discord) do update immediately after running **/sl reload**.

## Adding Language Files

```
# en-US.yml
prefix: "<white>[<gradient:#1420b1:#3631fd><b>ServerLinked</b></gradient><white>] "

no-permission: "<color:#ff3633>You do not have permission to use this command.</color>"
plugin-reloaded: "<color:#99ff40>Configuration and language files have been reloaded!</color>"
usage-add: "<color:#ff3633>Incorrect usage. Correct usage: /sl add <id> <name> <url> <true|false></color>"
usage-remove: "<color:#ff3633>Incorrect usage. Correct usage: /sl remove <id></color>"

link-added: "<color:#99ff40>Successfully added link!</color>"
link-removed: "<color:#99ff40>Successfully removed link!</color>"
link-not-found: "<color:#ff3633>That link ID does not exist.</color>"

help-border: "<gradient:#006eff:#ff5c85><st>=========================================</st></gradient>"
help-spacer: ""
help-header: "               <white>[<gradient:#1420b1:#3631fd><b>ServerLinked Help</b></gradient><white>]"
help-add: "<color:#ff2142>/sl add <id> <name> <url> <command> <gray>- Add a link</color>"
help-remove: "<color:#ff2142>/sl remove <id> <gray>- Remove a link</color>"
help-reload: "<color:#ff2142>/sl reload <gray>- Reload the plugin configuration</color>"

links-header: "<gradient:#1420b1:#3631fd><b>Available Server Links:</b></gradient>"

stats-header: "               <white>[<gradient:#1420b1:#3631fd><b>Link Analytics</b></gradient><white>]"
stats-reset-confirm: "<color:#ff3633>Are you sure? Type <yellow>/sl stats reset confirm</yellow> to wipe all data.</color>"
stats-reset-success: "<color:#99ff40>All click tracking data has been cleared!</color>"

broadcast-header: "<white>[<gradient:#1420b1:#3631fd><b>Announcement</b></gradient><white>]"
broadcast-text: "<white>⭐ Featured Link: {link}</white>"
broadcast-click: "<white><click:run_command:'/sl click {id}'><underlined>Click to open the link</underlined></click>"
```

* Copy the `en-US.yml` (default) language file provided above.
* Translate the text inside the quotation marks only. **Important:** Do not modify the `<color>` tags or placeholders (like `<url>`)
* Save your file using the standard `language-REGION` format (e.g., `es-MX.yml` for Spanish Mexico).
* Place your new `.yml` file into the `/plugins/ServerLinked/lang/` directory.
* Run `/sl reload` in-game or restart your server to initialize the new language.

## Config

```
# =============================================================================================
#
#     ███████╗███████╗██████╗ ██╗   ██╗███████╗██████╗ ██╗     ██╗███╗   ██╗██╗  ██╗███████╗██████╗
#     ██╔════╝██╔════╝██╔══██╗██║   ██║██╔════╝██╔══██╗██║     ██║████╗  ██║██║ ██╔╝██╔════╝██╔══██╗
#     ███████╗█████╗  ██████╔╝██║   ██║█████╗  ██████╔╝██║     ██║██╔██╗ ██║█████╔╝ █████╗  ██║  ██║
#     ╚════██║██╔══╝  ██╔══██╗╚██╗ ██╔╝██╔══╝  ██╔══██╗██║     ██║██║╚██╗██║██╔═██╗ ██╔══╝  ██║  ██║
#     ███████║███████╗██║  ██║ ╚████╔╝ ███████╗██║  ██║███████╗██║██║ ╚████║██║  ██╗███████╗██████╔╝
#     ╚══════╝╚══════╝╚═╝  ╚═╝  ╚═══╝  ╚══════╝╚═╝  ╚═╝╚══════╝╚═╝╚═╝  ╚═══╝╚═╝  ╚═╝╚══════╝╚═════╝
#
#                          ██████╗ ██████╗ ███╗   ██╗███████╗██╗ ██████╗
#                         ██╔════╝██╔═══██╗████╗  ██║██╔════╝██║██╔════╝
#                         ██║     ██║   ██║██╔██╗ ██║█████╗  ██║██║  ███╗
#                         ██║     ██║   ██║██║╚██╗██║██╔══╝  ██║██║   ██║
#                         ╚██████╗╚██████╔╝██║ ╚████║██║     ██║╚██████╔╝
#                          ╚═════╝ ╚═════╝ ╚═╝  ╚═══╝╚═╝     ╚═╝ ╚═════╝
#
# =============================================================================================

# Options: de-DE, en-US, es-ES, fr-FR, it-IT, pt-BR, ru-RU, zh-CN
# You can make your own language files using the template (make sure the file exists in the /lang/ folder)
# https://wxrs.gitbook.io/wxrs/serverlinked#adding-language-files
lang: en-US

# If set to true, the /links command will be enabled for players
# Permission: serverlinked.links
# If this is set to false, link stats will NOT work!
linkCommand: true

# This section is the links you want to show / use
# You can manage these in-game using:
# /sl add <id> <name> <url> <true/false>
# /sl remove <id>
#
# These links will appear in both /links and the "Server Links" tab in the pause menu.
#
# 'name' supports MiniMessage formatting (<red>, <#7289da>, etc.)
# 'command' (true/false) determines if a /<id> command is created
links:
  youtube: # This is the ID that will become your command (eg., /youtube)
    name: "<i><b><color:#ff0000>You</color></b><color:#ffffff>Tube</color></i>"
    url: "https://youtube.com/@yourchannel"
    command: true
    hovertext: "<white>Click to visit our channel!<br><color:#ff3633>New videos every Friday.</color>"
  discord:
    name: "<i><b><color:#7289da>Discord Server</color></b></i>"
    url: "https://discord.gg/invitecode"
    command: true
    hovertext: ""
  donate:
    name: "<i><b><gradient:#6dda0d:#51daca>Donate Here</gradient></b></i>"
    url: "https://store.yourserver.net"
    command: true
    hovertext: ""

# Automated Broadcast Settings
auto-broadcast:
  enabled: true
  interval-minutes: 30
  random: true # If set to "false" the broadcast will choose links one-by-one in order
  # List the ID's of the links you wish to broadcast
  list:
    - "youtube"
    - "discord"
    - "donate"
```

Made with ❤️​

<h2 align="center">Legal</h2>

<p align="center">Copyright © 2026 WXRS. All rights reserved. Redistribution, modification, or sale of this software is strictly prohibited. Usage is permitted for personal or commercial Minecraft servers only.</p>

{% columns %}
{% column width="33.33333333333333%" %}

<p align="center"><a href="https://discord.gg/3te5ypDG8h">Join The Discord</a> <i class="fa-discord" style="color:purple;">:discord:</i></p>
{% endcolumn %}

{% column width="33.33333333333333%" %}

<p align="center"><a href="https://www.spigotmc.org/members/wxrs.2513648/">Find Me On Spigot</a> <i class="fa-faucet-drip" style="color:$warning;">:faucet-drip:</i></p>
{% endcolumn %}

{% column %}

<p align="center"><a href="https://modrinth.com/user/wxr-s">Find Me On Modrinth</a> <i class="fa-wrench" style="color:$success;">:wrench:</i></p>
{% endcolumn %}
{% endcolumns %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://wxrs.gitbook.io/wxrs/serverlinked-1.21-26.1.1-v1.1.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `build a script that syncs our docs to a CMS` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
