EssentialsX 技术文档

EssentialsX 技术文档

Essentials The modern Essentials suite for Spigot and Paper. 项目地址: https://gitcode.com/gh_mirrors/es/Essentials

EssentialsX 是 Essentials 插件的衍生作品，专为支持现代 Minecraft 和 Spigot 版本设计。它不仅继承了原版 Essentials 的功能，还加入了大量新特性、性能优化和修复，这些都是原始 Essentials 或者其他兼容插件所不具备的。

安装指南

系统要求

1. 服务器软件: 必须使用 CraftBukkit、Spigot 或 Paper。
2. Minecraft版本: 支持从1.8.8到1.21.1之间的多个版本。
3. Java环境: 至少需要Java 8，推荐使用您的服务器软件所支持的最新Java版本。
4. 依赖插件: 必须安装Vault以启用聊天前缀/后缀和权限插件的支持，推荐搭配LuckPerms使用。

步骤

1. 首先，确保满足上述所有系统要求。
2. 访问 EssentialsX 下载页面，选择适用于您Minecraft版本的构建下载。
3. 将下载的.jar文件放置在您的服务器的plugins目录下。
4. 确保已安装Vault及其他必要的依赖（如使用LuckPerms作为权限管理）。
5. 启动服务器， EssentialsX 应自动加载。

使用说明

EssentialsX是即插即用式的，但一些高级功能可能需要配置。配置文件位于服务器根目录下的plugins/EssentialsX/config.yml。阅读配置文件注释了解每个设置项的作用，并根据需要进行调整。

命令示例

• /sethome 设置玩家家的位置。
• /tpa 请求传送到另一位玩家处。
• / kit <kitname> 获取预设的装备包。

详细命令列表及其使用方法，可在服务器中通过 /help 命令查看，或者参考 EssentialsX 官方Wiki。

API使用文档

开发者可以通过集成EssentialsX API来扩展其自定义插件的功能。要将EssentialsX作为依赖添加到你的Maven或Gradle项目，你可以参照以下配置：

对于最新发布版本:

<!-- Maven -->
<dependency>
  <groupId>net.essentialsx</groupId>
  <artifactId>EssentialsX</artifactId>
  <version>2.20.1</version>
</dependency>

<!-- Gradle -->
implementation 'net.essentialsx:EssentialsX:2.20.1'

对于快照版本或开发中版本:

<!-- Maven -->
<dependency>
  <groupId>net.essentialsx</groupId>
  <artifactId>EssentialsX</artifactId>
  <version>2.21.0-SNAPSHOT</version>
</dependency>

<!-- Gradle -->
implementation 'net.essentialsx:EssentialsX:2.21.0-SNAPSHOT'

请确保从EssentialsX Maven仓库获取这些依赖。

项目安装方式

对于那些想要从源代码构建EssentialsX的用户：

1. 确保你的系统已经安装了JDK 8或更高版本。
2. 克隆EssentialsX的GitHub仓库到本地。
3. 打开终端或命令提示符，导航至项目目录。
4. 运行构建命令：
   • 在Linux或macOS上：./gradlew build
   • 在Windows上：gradlew.bat build
5. 构建成功后，模块的 .jar 文件会出现在 jars/ 目录下。

结论

EssentialsX 是一个强大的工具集，为Minecraft服务器管理员提供了广泛的管理和游戏增强功能。无论是新手还是经验丰富的服务器管理员，通过适当配置和利用它的API，都能极大地丰富他们的服务器体验。记得加入社区，提供反馈和支持，共同推进这个项目的成长。

Essentials The modern Essentials suite for Spigot and Paper. 项目地址: https://gitcode.com/gh_mirrors/es/Essentials