Proxy-Utils 插件文档
由 MineFlow Studios 开发
概述
Proxy-Utils 是一款功能强大的 Velocity 代理插件,旨在通过提供一系列必需工具来简化服务器管理。凭借广播公告、管理服务器连接、处理代理重启以及监控插件状态等功能,Proxy-Utils 确保管理员和玩家都能获得无缝且高效的体验。
安装
- 下载
Proxy-Utils.jar 文件。
- 放置 JAR 文件到代理服务器的
plugins 目录中。
- 启动 你的 Velocity 代理服务器。配置文件(
settings.yml)将自动生成。
配置
位于 plugins/Proxy-Utils/ 目录下。
命令
通用命令
-
/announce <message>
向所有玩家广播自定义公告消息。支持使用 & 符号的颜色代码。
用法:
/announce <message>
示例:
/announce 欢迎来到服务器! &a祝您玩得愉快!
-
/proxyrestart [timeInSeconds]
启动代理服务器重启倒计时。如果未指定时间,则使用 settings.yml 中的默认重启时间。在倒计时期间,指定的广播间隔将通知玩家即将到来的重启。
用法:
/proxyrestart [timeInSeconds]
示例:
- 使用默认时间启动重启倒计时:
/proxyrestart
- 使用指定时间(例如 300 秒)启动重启倒计时:
/proxyrestart 300
-
/cancelproxyrestart
取消任何正在进行的代理重启倒计时。通知所有玩家重启已取消。
用法:
/cancelproxyrestart
-
/server [serverName]
将玩家发送到指定的服务器。如果未提供服务器名称,它将列出 settings.yml 中定义的所有可用服务器。
用法:
/server <serverName>
别名:
/srv
示例:
- 发送到特定服务器:
/server lobby
- 列出所有可用服务器:
/server
-
动态服务器命令(例如 /lobby, /smp, /hub)
提供对特定服务器的快速访问,无需使用 /server 命令。每个动态命令对应 settings.yml 中定义的服务器。
用法:
/<serverAlias>
示例:
- 发送到大厅服务器:
/lobby
- 发送到 SMP 服务器:
/smp
- 发送到大厅枢纽服务器:
/hub
-
/proxyplugins
列出代理的 plugins 目录中存在的所有插件 JAR 文件。指示每个插件是否正确加载(绿色)或未加载(红色)。此外,如果可用,还会显示每个插件的版本。
用法:
/proxyplugins
权限
| 权限节点 |
描述 |
默认访问权限 |
proxyutils.announce |
允许使用 /announce 命令。 |
管理员/Admins |
proxyutils.proxyrestart |
允许使用 /proxyrestart 命令。 |
管理员/Admins |
proxyutils.cancelproxyrestart |
允许使用 /cancelproxyrestart 命令。 |
管理员/Admins |
proxyutils.server |
允许使用 /server 命令。 |
所有玩家 |
proxyutils.server.<serverName> |
允许使用动态服务器命令(例如 /lobby)。 |
管理员/Admins |
proxyutils.proxyplugins |
允许使用 /proxyplugins 命令。 |
管理员/Admins |
权限设置示例(LuckPerms):
lp group admin permission set proxyutils.announce true
lp group admin permission set proxyutils.proxyrestart true
lp group admin permission set proxyutils.cancelproxyrestart true
lp group admin permission set proxyutils.server true
lp group admin permission set proxyutils.server.lobby true
lp group admin permission set proxyutils.server.smp true
lp group admin permission set proxyutils.server.hub true
lp group admin permission set proxyutils.proxyplugins true
注意事项:
- 动态服务器权限: 将
<serverName> 替换为 settings.yml 中定义的实际服务器标识符。例如,如果你有一个名为 lobby 的服务器,其权限节点应为 proxyutils.server.lobby。
- 控制台访问: 从控制台执行的命令不受权限检查限制,默认允许执行。
使用技巧
-
权限管理:
确保正确为用户组分配权限,以控制对各种命令的访问。通常,只有管理员才应拥有 /proxyrestart、/cancelproxyrestart 和 /proxyplugins 的访问权限。
-
服务器定义:
保持 settings.yml 中的服务器列表与所有活跃服务器同步更新,以确保玩家能够使用 /server 命令或动态服务器命令在不同服务器之间无缝切换。
-
广播间隔:
自定义 settings.yml 中的 broadcastIntervals,以控制向玩家通知即将进行的代理重启的频率,从而增强沟通并减少潜在的混淆。
-
插件监控:
定期使用 /proxyplugins 命令来监控已安装插件的状态,帮助你快速识别并解决与插件加载相关的问题。
-
颜色代码:
在 settings.yml 的消息中使用 & 符号来添加颜色和格式,使公告和通知更具视觉吸引力。
祝你使用 Proxy-Utils 轻松管理 Velocity 代理!
Proxy-Utils Plugin Documentation
Developed by MineFlow Studios
Overview
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.
Installation
- Download the
Proxy-Utils.jar file.
- Place the JAR in your proxy server's
plugins directory.
- Start your Velocity proxy server. Configuration files (
settings.yml) will be generated automatically.
Configuration
Located in plugins/Proxy-Utils/.
-
settings.yml
servers:
lobby: lobby-server
smp: smp-server
hub: hub-server
commands:
/lobby: lobby
/l: lobby
/smp: smp
/hub: hub
defaultRestartTime: 600 # Default restart time in seconds (e.g., 10 minutes)
broadcastIntervals:
- 600
- 300
- 60
- 50
- 25
- 10
- 9
- 8
- 7
- 6
- 5
- 4
- 3
- 2
- 1
messages:
announce: "&a[Announcement] &f{message}"
restartKick: "&cWe are restarting, please rejoin."
restartCancelled: "&cThe proxy restart has been &lCANCELLED!"
restartCountdown: "&cRestart in {timeLeft}..."
-
settings.yml Details:
-
servers:
Defines server identifiers and their corresponding server names.
-
commands:
Maps specific command aliases to server identifiers for dynamic server commands.
-
defaultRestartTime:
Sets the default time (in seconds) for the proxy restart countdown if no time is specified in the /proxyrestart command.
-
broadcastIntervals:
Specifies the intervals (in seconds) at which countdown messages are broadcasted to players during a proxy restart.
-
messages:
Customizable messages for various plugin actions, supporting color codes with the & symbol and placeholders like {message} and {timeLeft}.
Commands
General Commands
-
/announce <message>
Broadcasts a customized announcement message to all players. Supports color codes using the & symbol.
Usage:
/announce <message>
Example:
/announce Welcome to the server! &aEnjoy your stay!
-
/proxyrestart [timeInSeconds]
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.
Usage:
/proxyrestart [timeInSeconds]
Examples:
- Start a restart countdown with the default time:
/proxyrestart
- Start a restart countdown with a specified time (e.g., 300 seconds):
/proxyrestart 300
-
/cancelproxyrestart
Cancels any active proxy restart countdown. Notifies all players that the restart has been canceled.
Usage:
/cancelproxyrestart
-
/server [serverName]
Sends the player to the specified server. If no server name is provided, it lists all available servers as defined in settings.yml.
Usage:
/server <serverName>
Aliases:
/srv
Examples:
- Send to a specific server:
/server lobby
- List all available servers:
/server
-
Dynamic Server Commands (e.g., /lobby, /smp, /hub)
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.
Usage:
/<serverAlias>
Examples:
- Send to the lobby server:
/lobby
- Send to the SMP server:
/smp
- Send to the hub server:
/hub
-
/proxyplugins
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.
Usage:
/proxyplugins
Permissions
| Permission Node |
Description |
Default Access |
proxyutils.announce |
Allows the use of the /announce command. |
Administrators/Admins |
proxyutils.proxyrestart |
Allows the use of the /proxyrestart command. |
Administrators/Admins |
proxyutils.cancelproxyrestart |
Allows the use of the /cancelproxyrestart command. |
Administrators/Admins |
proxyutils.server |
Allows the use of the /server command. |
All Players |
proxyutils.server.<serverName> |
Allows the use of dynamic server commands (e.g., /lobby). |
Administrators/Admins |
proxyutils.proxyplugins |
Allows the use of the /proxyplugins command. |
Administrators/Admins |
Setting Permissions Example (LuckPerms):
lp group admin permission set proxyutils.announce true
lp group admin permission set proxyutils.proxyrestart true
lp group admin permission set proxyutils.cancelproxyrestart true
lp group admin permission set proxyutils.server true
lp group admin permission set proxyutils.server.lobby true
lp group admin permission set proxyutils.server.smp true
lp group admin permission set proxyutils.server.hub true
lp group admin permission set proxyutils.proxyplugins true
Notes:
- Dynamic Server Permissions: Replace
<serverName> with the actual server identifier as defined in your settings.yml. For example, if you have a server named lobby, the permission node would be proxyutils.server.lobby.
- Console Access: Commands executed from the console are not subject to permission checks and are permitted by default.
Usage Tips
-
Permissions Management:
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.
-
Server Definitions:
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.
-
Broadcast Intervals:
Customize the broadcastIntervals in settings.yml to control how frequently players are notified about impending proxy restarts, enhancing communication and reducing potential confusion.
-
Plugin Monitoring:
Regularly use the /proxyplugins command to monitor the status of installed plugins, helping you quickly identify and address any issues related to plugin loading.
-
Color Codes:
Utilize the & symbol in messages within settings.yml to add color and formatting, making announcements and notifications more visually appealing.
Enjoy managing your Velocity proxy with Proxy-Utils!
评论 0
登录后参与评分
还没有评论,来抢沙发吧