安装指南

本指南将帮助您在 Minecraft 服务器上正确安装和配置 EsbpmPlugin 插件。

前置要求

在安装 EsbpmPlugin 之前，请确保您的服务器满足以下要求：

• Minecraft 版本：1.21
• 服务端类型：Paper 或 Spigot 服务端（推荐使用 Paper 以获得更好的性能和兼容性）
• Java 版本：Java 17 或更高版本
• 服务器权限：您需要有管理服务器文件和重启服务器的权限

安装步骤

方法一：使用已编译的插件文件

1. 获取插件文件：

   • 从官方渠道下载最新版本的 EsbpmPlugin.jar 文件
   • 或从源代码编译得到插件文件（参见方法二）

2. 放置插件文件：

   • 连接到您的服务器文件系统
   • 导航到服务器根目录下的 plugins 文件夹
   • 将 EsbpmPlugin.jar 文件复制到 plugins 文件夹中

3. 重启服务器：

   • 执行服务器重启命令，或停止后再启动服务器
   • 这将使服务器加载新安装的插件

4. 验证安装：

   • 服务器启动后，检查控制台输出是否有与 EsbpmPlugin 相关的错误信息
   • 成功加载后，您应该能在 plugins 文件夹中看到生成的 EsbpmPlugin 目录

方法二：从源代码编译

如果您需要从源代码编译插件，请按照以下步骤操作：

1. 安装必要工具：

   • 确保您的系统已安装 JDK 17 或更高版本
   • 安装 Maven 构建工具（推荐使用最新版本）

2. 获取源代码：

   • 克隆或下载 EsbpmPlugin 的源代码仓库
   • 导航到源代码的根目录

3. 编译插件：

   • 打开命令行工具（如终端、PowerShell 或命令提示符）
   • 在源代码根目录执行以下 Maven 命令：

mvn clean package

4. 获取编译结果：

   • 编译完成后，在源代码根目录的 target 文件夹中会生成 EsbpmPlugin-1.0-SNAPSHOT.jar 文件
   • 这就是可用于服务器的插件文件

5. 安装编译后的插件：

   • 按照方法一中的步骤 2-4 安装和验证插件

首次启动与配置生成

插件首次启动时，会自动执行以下操作：

1. 在 plugins 文件夹中创建 EsbpmPlugin 目录
2. 在该目录下生成默认的 config.yml 配置文件
3. 注册插件的命令和事件监听器

服务器配置建议

为了确保 EsbpmPlugin 正常运行并获得最佳性能，建议您的服务器进行以下配置：

1. 内存分配：确保服务器分配了足够的内存，特别是在有大量玩家的服务器上

   • 对于小型服务器（10-20名玩家）：至少 2GB RAM
   • 对于中型服务器（20-50名玩家）：至少 4GB RAM
   • 对于大型服务器（50名以上玩家）：至少 6GB RAM 或更多

2. Paper 配置优化：

   • 建议使用 Paper 服务端并调整其配置以获得更好的性能
   • 特别是优化 paper.yml 中的相关设置

3. 定期备份：

   • 定期备份服务器世界和配置文件，以防不测
   • 特别是在修改插件配置或更新插件版本之前

多插件兼容性

EsbpmPlugin 设计为与大多数常见的 Minecraft 插件兼容，但在使用过程中仍需注意：

1. 权限插件：

   • 支持与 LuckPerms、PermissionsEx 等主流权限插件配合使用
   • 建议使用一种权限插件进行统一管理，避免冲突

2. 世界管理插件：

   • 可以与 Multiverse-Core 等世界管理插件配合使用
   • 注意在不同世界中可能需要调整插件配置以获得最佳效果

3. 其他游戏模式插件：

   • 如果同时使用多个管理游戏模式的插件，可能会出现冲突
   • 建议仅使用一种插件管理游戏模式，或确保它们的配置互补而非冲突

更新插件

当有新版本的 EsbpmPlugin 发布时，请按照以下步骤更新：

1. 备份现有配置：

   • 备份 plugins/EsbpmPlugin 目录下的 config.yml 文件和其他重要配置文件

2. 停止服务器：

   • 确保在更新插件前停止服务器

3. 替换插件文件：

   • 用新版本的 EsbpmPlugin.jar 文件替换 plugins 文件夹中的旧版本

4. 启动服务器：

   • 启动服务器并检查控制台输出是否有错误信息
   • 新版本可能会更新配置文件结构，请查看是否有相关提示

5. 验证功能：

   • 登录游戏验证插件的各项功能是否正常工作

卸载插件

如果您需要卸载 EsbpmPlugin，请按照以下步骤操作：

1. 停止服务器：

   • 确保在卸载插件前停止服务器

2. 删除插件文件：

   • 从 plugins 文件夹中删除 EsbpmPlugin.jar 文件
   • （可选）删除 plugins 文件夹中的 EsbpmPlugin 目录（包含配置文件）

3. 启动服务器：

   • 启动服务器，插件将不再加载

注意：卸载插件后，之前由插件管理的飞行状态、游戏模式等设置将不再被控制，但不会影响玩家的其他数据。