PermissionsEx 技术文档

1. 安装指南

1.1 平台支持

PermissionsEx (PEX) 是一个全面的权限管理插件，支持多种服务器和代理平台：

• Bukkit/Spigot/Paper
• Sponge (API 8 和 API 7)
• BungeeCord/Waterfall
• Velocity
• Fabric

1.2 下载与安装

1. 从 Jenkins 获取最新构建：

   • 访问 Jenkins 获取最新的构建版本。
   • 下载适用于您平台的构建文件（如 bukkit-2.0-SNAPSHOT.jar）。

2. 安装插件：

   • 将下载的 .jar 文件放入服务器的 plugins 目录。
   • 启动服务器，插件将自动加载。

1.3 Maven 和 Gradle 依赖

如果您需要在项目中使用 PermissionsEx 的 API，可以通过 Maven 或 Gradle 添加依赖：

Maven

<repository>
    <id>pex-repo</id>
    <url>https://repo.glaremasters.me/repository/permissionsex/</url>
</repository>

<dependency>
    <groupId>ca.stellardrift.permissionsex</groupId>
    <artifactId>permissionsex-core</artifactId>
    <version>2.0-SNAPSHOT</version>
</dependency>

Gradle

repositories {
    maven(url = "https://repo.glaremasters.me/repository/permissionsex/") {
        name = "pex-repo"
    }
}

dependencies {
    implementation("ca.stellardrift.permissionsex:permissionsex-core:2.0-SNAPSHOT")
}

2. 项目使用说明

2.1 权限管理

PermissionsEx 提供了详细的权限管理功能，允许服务器管理员对权限进行精细控制。您可以通过配置文件或命令行来管理权限。

2.2 命令行工具

PermissionsEx 提供了丰富的命令行工具，用于管理用户、角色和权限。常用的命令包括：

• /pex user <用户> add <权限>：为用户添加权限。
• /pex group <组> remove <权限>：从组中移除权限。
• /pex reload：重新加载配置文件。

2.3 配置文件

PermissionsEx 的配置文件位于 plugins/PermissionsEx 目录下。主要的配置文件包括：

• config.yml：包含插件的全局配置。
• permissions.yml：包含用户和组的权限设置。

3. 项目API使用文档

3.1 核心API

PermissionsEx 提供了一个核心 API，允许开发者在其插件中查询和管理权限。核心 API 的主要类包括：

• PermissionsEx：主类，提供权限查询和管理的方法。
• Subject：表示一个权限主体（用户或组）。
• Context：表示权限上下文，用于更复杂的权限管理。

3.2 示例代码

以下是一个简单的示例，展示如何使用 PermissionsEx API 查询用户的权限：

PermissionsEx pex = PermissionsEx.getPermissionManager();
Subject user = pex.getSubjects("user").get("username");
boolean hasPermission = user.hasPermission("some.permission");

4. 项目安装方式

4.1 手动安装

1. 下载适用于您平台的 .jar 文件。
2. 将文件放入服务器的 plugins 目录。
3. 启动服务器，插件将自动加载。

4.2 使用 Maven 或 Gradle

如果您需要在项目中使用 PermissionsEx 的 API，可以通过 Maven 或 Gradle 添加依赖，如上文所述。

4.3 开发构建

如果您需要最新的开发构建版本，可以访问 Jenkins 获取。

5. 贡献指南

PermissionsEx 欢迎开发者贡献代码、文档改进和翻译。所有贡献必须遵循以下许可证：

• 非 Bukkit 实现的贡献必须使用 Apache 2.0 许可证。
• Bukkit/Spigot/Paper 实现的贡献必须使用 GNU General Public License, version 3 或更高版本。

5.1 构建项目

PermissionsEx 使用 Gradle 进行构建。您可以通过运行 ./gradlew build 来构建项目。

5.2 提交贡献

在提交贡献之前，建议先在 Discord 上讨论您的想法，以确保其符合项目的愿景。

---

通过以上文档，您应该能够顺利安装、使用和扩展 PermissionsEx 插件。如有任何问题，欢迎加入我们的 Discord 社区进行讨论。