DiscordStatusPlugin or OSB

Plugin for working with Discord Webhooks, server TAB and server modes

DiscordStatusPlugin for Minecraft Servers

Overview

DiscordStatusPlugin is a sophisticated plugin designed for Paper 1.21 and later versions, offering seamless integration with Discord for automated server status updates and advanced tablist prefix management. It enhances server administration by providing tools for communication and organization, tailored for both players and staff.

Key Features

Discord Webhook Integration

Automatically sends visually appealing embed messages to a designated Discord channel when the server starts, stops, or when SOS mode is toggled, ensuring your community stays informed.

SOS Mode

Enables temporary restriction of player logins to administrators, owners, and moderators, making it ideal for maintenance or emergency scenarios.

Custom Tab Prefixes

Simplifies group management with customizable, color-coded prefixes in the tablist for Owners, Moderators, VIPs, and Default players, enhancing visual organization.

Tablist Customization

Supports dynamic tablist headers and footers with placeholders for TPS, ping, online player count, and server time, providing a personalized in-game experience.

In-Game Commands

  • /sos on|off: Toggles SOS mode to restrict or allow regular player logins.

  • /setprefix <Player> <Group>: Assigns a player to a specific tab prefix group.

  • /addprefix <Group>: Creates a new tab prefix group.

  • /removeprefix <Player>: Removes a player’s tab prefix group.

  • /setdiscord <link>: Updates the Discord invite link (requires permission).

  • /helpplugin: Displays a comprehensive list of plugin commands with descriptions.

How It Works

  • Server Online/Offline: Sends an embed message to the Discord channel when the server starts or stops, keeping the community updated.

  • SOS Mode: When enabled, restricts server access to staff (Owners/Moderators) and provides a custom kick message with the Discord invite link for other players.

  • Tab Prefixes: Allows customizable group prefixes in the tablist, managed through the tabconfig.yml configuration file.

  • Discord Webhook: Delivers server status updates as formatted Discord embeds with distinct colors for different events.

Configuration Files

  • config.yml: Manages tab prefix groups and player assignments.

  • tabconfig.yml: Customizes tablist headers, footers, and group prefix colors.

  • plugin.yml: Defines command registrations and associated permissions.

Example Discord Embeds

  • Server Online: Blue border, bold title: "Server online now"

  • Server Offline: Blue border, bold title: "Server offline now"

  • SOS Enabled: Red border, title: "You can join the server"

  • SOS Disabled: Red border, title: "You can't join the server"

  • Default: Gray border, title: "The server is working fine"

Permissions

  • discordstatus.setdiscord: Grants access to the /setdiscord command for updating the Discord invite link.

Requirements

  • PaperMC 1.21 or newer

  • Java 17 or higher

Installation

  1. Place the plugin JAR file in your server’s plugins folder.

  2. Configure the Discord webhook in the plugin’s source or configuration file, if required.

  3. Restart the server.

  4. Use the /helpplugin command in-game to explore available commands.

Summary

DiscordStatusPlugin enhances Minecraft server management by integrating Discord communication and providing robust tablist customization. It ensures efficient staff coordination and keeps your community well-informed with automated, visually appealing updates.

The DiscordStatusPlugin or OSB Team

profile avatar
  • 1
    Projects
  • 22
    Downloads