ServerLinks

Adds a convenient way to display your server links directly in the Minecraft client pause menu.

This is one of the features introduced in version 1.21 but unavailable in the base game by default. Now you can showcase important resources of your project to players, such as websites, forums, community guidelines, or other helpful pages.

Both popular platforms are supported - Velocity and Spigot (including all derivative versions).

Requirements

• Minecraft version 1.21 or higher
• For Spigot servers requires:
  • ProtocolLib version 5.1.0 or newer

Configuration Settings

For Spigot Servers

Configuration file: config.yml

server-links:
  # Standard link types known to the client:
  # BUG_REPORT, COMMUNITY_GUIDELINES, SUPPORT, STATUS, FEEDBACK, COMMUNITY, WEBSITE, FORUMS, NEWS, ANNOUNCEMENTS
  - type: WEBSITE
    url: "https://github.com/MeowCraftMC/ServerLinks"
  # Custom type with arbitrary text
  # Supports formatting codes (like &a) and HEX colors (&##66ccff).
  - type: CUSTOM
    text: "&6Arbitrary text"
    url: "https://www.example.com"

For Velocity Servers

Configuration file: config.conf

server-links=[
    {
        type=WEBSITE
        url="https://github.com/MeowCraftMC/ServerLinks"
    },
    {
        label="&bCustom example.com"
        url="https://www.example.com"
    }
]

Commands and Permissions

For Spigot

Use the command /serverlinks reload to reload configuration without server restart.

Permission system:

• serverlinks.admin - for administrators with configuration reload rights
• serverlinks.user - for regular players allowed to see links

For Velocity

Configuration is reloaded using the standard /velocity reload command. No additional permissions required.

Visual Example

Licensing

Distributed under SSPL-1.0 license
Copyright (c) 2024 qyl27

This program is free software: you can redistribute it and/or modify it under the terms of the Server Side Public License, version 1, as published by MongoDB, Inc. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the Server Side Public License for more details. You should have received a copy of the Server Side Public License along with this program. If not, see <http://www.mongodb.com/licensing/server-side-public-license&gt;.