—<\/p>\n
**Proxy-Utils Plugin Documentation**<\/p>\n
*Developed by MineFlow Studios*<\/p>\n
—<\/p>\n
## **Overview**<\/p>\n
Proxy-Utils is a powerful Velocity proxy plugin designed to streamline server management by offering a range of essential tools. With features such as broadcasting announcements, managing server connections, handling proxy restarts, and monitoring plugin statuses, Proxy-Utils ensures a seamless and efficient experience for both administrators and players.<\/p>\n
—<\/p>\n
## **Installation**<\/p>\n
1. **Download** the `Proxy-Utils.jar` file.
\n2. **Place** the JAR in your proxy server’s `plugins` directory.
\n3. **Start** your Velocity proxy server. Configuration files (`settings.yml`) will be generated automatically.<\/p>\n
—<\/p>\n
## **Configuration**<\/p>\n
Located in `plugins\/Proxy-Utils\/`.<\/p>\n
– **settings.yml**
\n “`yaml
\n servers:
\n lobby: lobby-server
\n smp: smp-server
\n hub: hub-server<\/p>\n
commands:
\n \/lobby: lobby
\n \/l: lobby
\n \/smp: smp
\n \/hub: hub<\/p>\n
defaultRestartTime: 600 # Default restart time in seconds (e.g., 10 minutes)<\/p>\n
broadcastIntervals:
\n – 600
\n – 300
\n – 60
\n – 50
\n – 25
\n – 10
\n – 9
\n – 8
\n – 7
\n – 6
\n – 5
\n – 4
\n – 3
\n – 2
\n – 1<\/p>\n
messages:
\n announce: “&a[Announcement] &f{message}”
\n restartKick: “&cWe are restarting, please rejoin.”
\n restartCancelled: “&cThe proxy restart has been &lCANCELLED!”
\n restartCountdown: “&cRestart in {timeLeft}…”
\n “`<\/p>\n
– **settings.yml** Details:<\/p>\n
– **servers:**
\n Defines server identifiers and their corresponding server names.<\/p>\n
– **commands:**
\n Maps specific command aliases to server identifiers for dynamic server commands.<\/p>\n
– **defaultRestartTime:**
\n Sets the default time (in seconds) for the proxy restart countdown if no time is specified in the `\/proxyrestart` command.<\/p>\n
– **broadcastIntervals:**
\n Specifies the intervals (in seconds) at which countdown messages are broadcasted to players during a proxy restart.<\/p>\n
– **messages:**
\n Customizable messages for various plugin actions, supporting color codes with the `&` symbol and placeholders like `{message}` and `{timeLeft}`.<\/p>\n
—<\/p>\n
## **Commands**<\/p>\n
### **General Commands**<\/p>\n
– **`\/announce **Usage:** **Example:** – **`\/proxyrestart [timeInSeconds]`** **Usage:** **Examples:** – **`\/cancelproxyrestart`** **Usage:** – **`\/server [serverName]`** **Usage:** **Aliases:** **Examples:** – **Dynamic Server Commands (e.g., `\/lobby`, `\/smp`, `\/hub`)** **Usage:** **Examples:** – **`\/proxyplugins`** **Usage:** —<\/p>\n ## **Permissions**<\/p>\n | **Permission Node** | **Description** | **Default Access** | **Setting Permissions Example (LuckPerms):** **Notes:** —<\/p>\n ## **Usage Tips**<\/p>\n – **Permissions Management:** – **Server Definitions:** – **Broadcast Intervals:** – **Plugin Monitoring:** – **Color Codes:** —<\/p>\n **Enjoy managing your Velocity proxy with Proxy-Utils!**<\/p>\n —<\/p>\n","protected":false},"excerpt":{"rendered":" Proxy-Utils is a Velocity plugin providing administrative commands for announcements, server management, proxy restarts, and plugin status display.<\/p>\n","protected":false},"featured_media":125877,"template":"","meta":{"_minecraft_slug":"proxy-utils","_minecraft_project_id":"zJsIjeKW","_minecraft_author":"Kron","_minecraft_license":"LicenseRef-All-Rights-Reserved","_minecraft_downloads":292,"_minecraft_follows":1,"_minecraft_client_side":"unsupported","_minecraft_server_side":"required","_minecraft_storage_type":"zip","_minecraft_archive_name":"proxy-utils.zip","_minecraft_size_bytes":13322567,"_minecraft_version_count":1,"_minecraft_updated_at":"2026-05-16T11:47:34.301936Z","_minecraft_date_created":"2025-01-21T09:27:00.504684Z","_minecraft_date_modified":"2025-01-19T14:34:10.601327Z","_minecraft_project_url":"https:\/\/modrinth.com\/mod\/proxy-utils","_minecraft_icon_attachment_id":125877,"_minecraft_imported_at":"2026-06-07T09:32:50+00:00","_minecraft_import_hash":"7e602b2aea9d03e402a48be418a8e239","_minecraft_versions":"","_minecraft_links":"","_minecraft_gallery":"","_minecraft_api_metadata":""},"mod_category":[126,90,92,985],"mod_loader":[986],"minecraft_version":[37,73,74,38],"class_list":["post-125876","mod","type-mod","status-publish","has-post-thumbnail","hentry","mod_category-management","mod_category-optimization","mod_category-utility","mod_category-velocity","mod_loader-velocity","minecraft_version-1-21-1","minecraft_version-1-21-2","minecraft_version-1-21-3","minecraft_version-1-21-4"],"yoast_head":"\n
\n *Broadcasts a customized announcement message to all players. Supports color codes using the `&` symbol.*<\/p>\n
\n “`
\n \/announce
\n “`<\/p>\n
\n “`
\n \/announce Welcome to the server! &aEnjoy your stay!
\n “`<\/p>\n
\n *Initiates a countdown to restart the proxy server. If no time is specified, the default restart time from `settings.yml` is used. During the countdown, specified broadcast intervals will notify players of the impending restart.*<\/p>\n
\n “`
\n \/proxyrestart [timeInSeconds]
\n “`<\/p>\n
\n – Start a restart countdown with the default time:
\n “`
\n \/proxyrestart
\n “`
\n – Start a restart countdown with a specified time (e.g., 300 seconds):
\n “`
\n \/proxyrestart 300
\n “`<\/p>\n
\n *Cancels any active proxy restart countdown. Notifies all players that the restart has been canceled.*<\/p>\n
\n “`
\n \/cancelproxyrestart
\n “`<\/p>\n
\n *Sends the player to the specified server. If no server name is provided, it lists all available servers as defined in `settings.yml`.*<\/p>\n
\n “`
\n \/server
\n “`<\/p>\n
\n “`
\n \/srv
\n “`<\/p>\n
\n – Send to a specific server:
\n “`
\n \/server lobby
\n “`
\n – List all available servers:
\n “`
\n \/server
\n “`<\/p>\n
\n *Provides quick access to specific servers without the need to use the `\/server` command. Each dynamic command corresponds to a server defined in `settings.yml`.*<\/p>\n
\n “`
\n \/
\n “`<\/p>\n
\n – Send to the lobby server:
\n “`
\n \/lobby
\n “`
\n – Send to the SMP server:
\n “`
\n \/smp
\n “`
\n – Send to the hub server:
\n “`
\n \/hub
\n “`<\/p>\n
\n *Lists all plugin JAR files present in the proxy’s plugins directory. Indicates whether each plugin is loaded correctly (green) or not loaded (red). Additionally, displays the version of each plugin if available.*<\/p>\n
\n “`
\n \/proxyplugins
\n “`<\/p>\n
\n|———————————–|———————————————————–|————————-|
\n| `proxyutils.announce` | Allows the use of the `\/announce` command. | Administrators\/Admins |
\n| `proxyutils.proxyrestart` | Allows the use of the `\/proxyrestart` command. | Administrators\/Admins |
\n| `proxyutils.cancelproxyrestart` | Allows the use of the `\/cancelproxyrestart` command. | Administrators\/Admins |
\n| `proxyutils.server` | Allows the use of the `\/server` command. | All Players |
\n| `proxyutils.server.
\n| `proxyutils.proxyplugins` | Allows the use of the `\/proxyplugins` command. | Administrators\/Admins |<\/p>\n
\n“`
\nlp group admin permission set proxyutils.announce true
\nlp group admin permission set proxyutils.proxyrestart true
\nlp group admin permission set proxyutils.cancelproxyrestart true
\nlp group admin permission set proxyutils.server true
\nlp group admin permission set proxyutils.server.lobby true
\nlp group admin permission set proxyutils.server.smp true
\nlp group admin permission set proxyutils.server.hub true
\nlp group admin permission set proxyutils.proxyplugins true
\n“`<\/p>\n
\n– **Dynamic Server Permissions:** Replace `
\n– **Console Access:** Commands executed from the console are not subject to permission checks and are permitted by default.<\/p>\n
\n Ensure that permissions are correctly assigned to user groups to control access to various commands. Typically, only administrators should have access to `\/proxyrestart`, `\/cancelproxyrestart`, and `\/proxyplugins`.<\/p>\n
\n Keep your `settings.yml` up-to-date with all active servers to ensure that players can seamlessly switch between them using the `\/server` commands or dynamic server commands.<\/p>\n
\n Customize the `broadcastIntervals` in `settings.yml` to control how frequently players are notified about impending proxy restarts, enhancing communication and reducing potential confusion.<\/p>\n
\n Regularly use the `\/proxyplugins` command to monitor the status of installed plugins, helping you quickly identify and address any issues related to plugin loading.<\/p>\n
\n Utilize the `&` symbol in messages within `settings.yml` to add color and formatting, making announcements and notifications more visually appealing.<\/p>\n