Feature: Interactive Console Channel
The Interactive Console Channel is a powerful feature that turns a private Discord channel into a live feed of your server's console. Authorized users can not only view the console logs but also execute commands directly from Discord as if they were typing into the server console itself.
Security First! This feature grants significant power. It is disabled by default. Please read this guide carefully and ensure your Discord channel permissions are set correctly to restrict access to trusted staff members only.
How It Works
- Log Forwarding: The plugin intercepts all console output (from the server and other plugins), filters it for sensitive information, and sends it to the designated Discord channel in real-time.
- Command Execution: Any message sent in the console channel by a user with a role listed in
allowed-roles
will be executed by the server console.
Configuration: console.yml
This feature is controlled entirely by the console.yml
file.
# Set to 'true' to enable this feature.
enabled: false
# The ID of the Discord channel to use as the console.
# This channel should be private and only visible to trusted staff.
channelId: "YOUR_CONSOLE_CHANNEL_ID_HERE"
# A list of Discord role names that are allowed to execute commands.
# This IS case-sensitive and must exactly match the role names in Discord.
allowed-roles:
- "Owner"
- "Head-Admin"
# --- Security & Filtering ---
# To protect your server and players, log messages are filtered before being sent to Discord.
# Any line matching one of these regex patterns will NOT be sent.
filter-patterns:
# Blocks lines containing IP addresses (e.g., player join messages)
- '(\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3})'
# Blocks potentially sensitive commands from being echoed (e.g., passwords)
- '(?i)lp user .* password'
- '(?i)authme register'
- '(?i)login'
- '(?i)register'
# Example: Blocks noisy messages from a specific plugin
# - '(?i)\[LuckPerms\]'
# If true, the timestamp and log level prefix (e.g., "[20:30:15 INFO]: ") will be
# stripped from messages, resulting in a cleaner look in Discord.
strip-prefix: true
Key Settings Explained
-
enabled
: The master switch for the entire feature. Must betrue
to activate. -
channelId
: You must provide a valid Discord channel ID here. It is highly recommended to use a private channel that only administrators can see. -
allowed-roles
: This is your primary security control for command execution. Only members with at least one of these Discord roles can run commands. Messages from users without these roles will be ignored (or receive a "no permission" reply). -
filter-patterns
: A powerful tool to prevent sensitive information from being leaked to Discord. The default patterns block IP addresses and common password-related commands. You can add your own regex patterns here to filter out anything you don't want to appear in the log channel.
How to use Regex: The
filter-patterns
use Java-style regular expressions. You can use a tool like regex101.com to test your patterns. The (?i)
prefix makes a pattern case-insensitive.