pMessage
一个API,让您的服务器上的插件消息保持一致!
点此下载插件详细介绍
pMessage 是一款用于在 Minecraft 服务器上实现统一插件消息格式的 API。它可以让所有安装的插件以相同的格式向玩家发送消息,从而使您的服务器看起来更专业。您可以自定义消息格式,以及错误、成功和信息消息的颜色,还有自定义的“无权限”和“必须是玩家”消息。
📦 pMessage
📌 主要特性
- 统一服务器插件消息格式
- 可定制的消息格式
- 可定制的错误、成功和信息颜色
- 可定制的“无权限”和“必须是玩家”消息
⌨️ 命令
/pmessage- 插件主命令(也是唯一命令)。/pmessage reload- 重载配置文件。
🔑 权限
pmessage.reload- 使用/pmessage reload命令的权限。
👨💻 API 使用
本节介绍如何在您的插件中使用 pMessage API。
🛠️ 集成步骤
- 像添加 Spigot/Craftbukkit jar 文件一样,将 pMessage 添加到您的 IDE 项目中(例如,在 Eclipse 中,将其作为外部库添加到项目的构建路径中)。
- 在您的插件主类中创建
Messenger类的一个实例:
Messenger msg;
public void onEnable(){
if(getServer().getPluginManager().isPluginEnabled("pMessage"))
msg = new Messenger(this);
}
- 当您想要发送消息时,调用以下任何方法。所有方法的
receiver参数都接受一个CommandSender,因此您可以传递控制台或玩家。 - 在您的
plugin.yml文件中添加 pMessage 作为依赖项。
⚙️ 方法
msg.needPermission(CommandSender receiver);
向玩家/控制台发送服务器所有者定义的“需要权限”消息。当 .hasPermission 或 .isOp 返回 false 时,应使用此方法。
msg.needPlayer(CommandSender receiver);
向玩家/控制台(通常是控制台)发送服务器所有者定义的“必须是玩家”消息。当 instanceof Player 返回 false 时,应使用此方法。
msg.error(CommandSender receiver, String message);
向玩家/控制台发送一条带有服务器所有者定义的错误颜色的消息。当您想要发送错误消息时,应使用此方法。
msg.success(CommandSender receiver, String message);
向玩家/控制台发送一条带有服务器所有者定义的成功颜色的消息。当您想要发送成功消息时,应使用此方法。
msg.info(CommandSender receiver, String message);
向玩家/控制台发送一条带有服务器所有者定义的信息颜色的消息。当您想要发送既不是错误消息也不是成功消息的消息时,应使用此方法。
msg.msg(CommandSender receiver, String message, ChatColor colour);
向玩家/控制台发送一条带有您指定的颜色的消息,但使用服务器所有者的消息格式。
🧰 变量
msg.ERROR_COLOR;
获取服务器所有者设置的所有错误消息的颜色。
msg.INFO_COLOR;
获取服务器所有者设置的所有信息消息的颜色。
msg.SUCCESS_COLOR;
获取服务器所有者设置的所有成功消息的颜色。
🛠️ 服务器配置
本节面向服务器所有者,介绍如何配置 pMessage。如果您是开发人员,请参阅上面的 API 使用部分。
配置文件允许您调整插件消息的外观。
对于“success”、“error”和“info”,这些值可以是任何颜色代码的名称形式。有关接受的颜色列表,请查阅相关文档并使用“技术名称”列下的值。
format- 消息的整体格式。可以是任何内容,但必须包含%plugin%和%message%(不带引号)。%plugin%将被替换为发送消息的插件名称,%message%将被替换为消息本身。您应该始终在%message%之前添加&r,这样可以防止消息颜色出现故障。success- 所有插件定义为成功消息的聊天颜色。默认颜色为绿色。error- 所有插件定义为错误消息的聊天颜色。默认颜色为红色。info- 所有插件定义为信息消息的聊天颜色。默认颜色为金色。no-permission- 当插件想要通知玩家他们没有权限时发送的消息。此值将在上面设置的“format”中使用,替换%message%。no-player- 当插件想要通知控制台只有玩家才能执行命令时发送的消息。此值将在上面设置的“format”中使用,替换%message%。
⚙️ 默认配置示例
format: '&7[&b%plugin%&7] &r%message%'
success: green
error: red
info: gold
no-permission: '&cYou do not have permission to do this!'
no-player: '&cOnly players can execute this command!'
🚀 安装
只需将 pMessage.jar 拖放到您的 /plugins 文件夹中。然后重启或重载您的服务器即可!
请注意,此插件本身不会做太多事情。它主要是一个 API,因此除非其他插件使用它,否则不需要使用它。
此外,并非所有插件都使用 pMessage,因此并非所有插件消息都将由 pMessage 格式化。只有支持它的插件才会被格式化。
Discord: https://discord.gg/011Ko7udD8zmZt8JN