CharacterDialogue - 角色对话与任务系统

💡插件简介

这是一个用于管理 Minecraft 服务器的插件。它提供了一系列工具和功能，帮助管理员更高效地维护服务器秩序、处理玩家事务以及优化游戏环境。通过简单的命令和配置，您可以轻松实现各种管理操作。

🎮核心功能

主要特性

• 玩家管理：处理玩家封禁、踢出、警告等操作。
• 服务器维护：执行重启、关闭、备份等服务器控制命令。
• 聊天管理：监控和过滤聊天内容，设置聊天格式。
• 物品与实体控制：清理掉落物、清除特定实体。
• 玩家查询：查看玩家信息、库存、位置等数据。

实用工具

• 飞行模式：允许特定玩家在生存模式下飞行。
• 游戏模式切换：快速切换玩家或自己的游戏模式。
• 时间与天气控制：调整游戏内的时间和天气。
• 传送管理：在玩家之间或指定坐标进行传送。

🔧命令与权限

常用命令列表

• /ban <玩家> [原因] - 封禁指定玩家。
• /kick <玩家> [原因] - 将玩家踢出服务器。
• /gm <0|1|2|3> [玩家] - 切换游戏模式。
• /fly [玩家] - 切换飞行模式。
• /tp <玩家> [目标玩家] - 传送到玩家或传送玩家。
• /time set <day|night> - 设置游戏时间。
• /weather <clear|rain|thunder> - 设置天气。
• /clear <玩家> - 清空玩家物品栏。
• /invsee <玩家> - 查看玩家物品栏。

关键权限节点

• plugin.use - 使用基础命令的权限。
• plugin.admin - 使用所有管理命令的权限。
• plugin.ban - 执行封禁操作的权限。
• plugin.kick - 执行踢出操作的权限。
• plugin.fly - 允许使用飞行模式的权限。
• plugin.gamemode - 切换游戏模式的权限。
• plugin.teleport - 使用传送命令的权限。

❓安装与配置

安装步骤

• 确保服务器已安装并运行了 Spigot、Paper 或兼容的服务端。
• 将下载的插件 .jar 文件放入服务器的 plugins 文件夹。
• 重启服务器以加载插件。
• 插件首次运行后，会在 plugins 文件夹内生成配置文件和数据文件夹。

基础配置

插件的主要配置文件为 config.yml。您可以在其中调整：

• 插件的前缀和消息语言。
• 各种功能的默认开关状态。
• 封禁、踢出等操作的默认原因。
• 聊天过滤的关键词列表。

建议在修改配置后重启服务器或使用重载命令使更改生效。

✨注意事项与兼容性

运行环境要求

• 服务端： Spigot 1.13.x 或更高版本，Paper 端兼容性更佳。
• Java： 需要 Java 8 或更高版本。
• 依赖： 本插件为独立插件，通常无需额外依赖。但部分高级功能可能需要 Vault 插件以支持经济系统。

重要提示

• 请定期备份插件的数据文件，以防数据丢失。
• 在使用具有破坏性的命令（如封禁、清空物品栏）前，请务必确认目标。
• 确保拥有相应权限的玩家才能使用管理命令，以维护服务器安全。
• 如果遇到问题，请检查服务器日志以获取详细的错误信息。

本文档为 CharacterDialogue 插件的 API 使用说明，旨在帮助开发者扩展插件功能。请注意，更详细的文档将在 GitHub Wiki 中提供。

💡前置依赖

为避免出现问题，你首先需要在你的插件 plugin.yml 中将其添加为软依赖。

• 在 plugin.yml 中添加：

  softdepend: [CharacterDialogue]

🎮获取 API 实例

要获取 API，只需调用插件的主类。

CharacterDialogueAPI api = CharacterDialoguePlugin.getInstance().getApi();

通过此 API 实例，你可以使用插件提供的一些实用方法，其中包括启动对话的方法。

🎮执行对话

API 提供了执行对话的方法，其参数说明如下。

CharacterDialogueAPI#executeDialog(List<String>, Player, ClickType, int, String);
CharacterDialogueAPI#executeDialog(List<String>, Player, String);

参数说明

• List<String>：要执行的对话文本行。
• Player：负责交互的玩家。
• ClickType：玩家执行的点击类型（可选）。
• int：NPC 的 ID（可选）。
• String：NPC 的显示名称。

为何需要这些参数？

这很简单。插件内置了一个事件，当方法被执行时便会触发。像 ClickType 和 Npc ID 这类参数是可选的。

✨创建自定义方法

要创建一个自定义对话方法，你需要新建一个类并继承 DialogMethod。

import org.bukkit.entity.Player;
import me.iatog.characterdialogue.dialogs.DialogMethod;
import me.iatog.characterdialogue.session.DialogSession;

public class ExampleMethod extends DialogMethod {
    public ExampleMethod() {
        super("example");
    }

    @Override
    public void execute(Player player, String arg, DialogSession session) {
        player.sendMessage("§aHello world, " + player.getName());
    }
}

✨注册自定义方法

创建方法类后，必须将其注册到插件中。调用插件主类并使用 registerMethods 方法。

CharacterDialoguePlugin characterDialogue = CharacterDialoguePlugin.getInstance();
characterDialogue.registerMethods(new ExampleMethod());

完成以上步骤后，你的自定义方法就已成功注册并可以使用了。