NextLib

插件

· 作者 chi2l3s

轻松构建 Minecraft 插件

0 本站下载 0 关注 更新于 1 年前

最新 1.0.5 · 1.21.10 · Bukkit / Paper

一键开服(送7天)

NextLib

WIKI

CodeFactor JitPack Downloads

NextLib 是一个面向 Paper/Spigot 插件的模块化库,涵盖了基础开发任务:配置文件、GUI(图形用户界面)、对象和数据库的处理。所有模块均专注于声明式风格,并便于集成到现有项目中。


目录

  1. 功能特性
  2. 安装
  3. 快速开始
  4. 核心模块
  5. GUI API 与条件
  6. 配置文件处理
  7. 路线图
  8. 许可证

功能特性

  • 动态数据库 — 通过常规 Java 类和注解描述实体,库会自动创建表并提供用于 CRUD 操作的便捷 Fluent API。
  • 通过 HikariCP 连接数据库 — 提供可配置参数的现成连接池。
  • 灵活的 GUI — 支持从 YAML 加载菜单,包含显示条件和内置操作(update、playsound、command、opengui 等)。
  • 命令 API — 带有自动补全功能的命令树。
  • 物品 API — 简洁的物品构建器,支持 PDC、标题、描述文本和玩家头颅。
  • 颜色 API — 格式化 HEX 和 & 代码,无需额外代码。
  • 配置管理器 — 将 YAML 配置文件以声明式方式加载到 Java 对象中。

安装

在构建脚本中添加 JitPack 仓库和 1.0.5 依赖。

Gradle (Kotlin DSL)

repositories {
    mavenCentral()
    maven("https://jitpack.io")
}

dependencies {
    implementation("com.github.chi2l3s:next-lib:1.0.5")
}

Gradle (Groovy DSL)

repositories {
    mavenCentral()
    maven { url 'https://jitpack.io' }
}

dependencies {
    implementation 'com.github.chi2l3s:next-lib:1.0.5'
}

Maven

<repositories>
    <repository>
        <id>jitpack</id>
        <url>https://jitpack.io/</url>
    </repository>
</repositories>

<dependency>
    <groupId>com.github.chi2l3s</groupId>
    <artifactId>next-lib</artifactId>
    <version>1.0.5</version>
    <scope>provided</scope>
</dependency>

快速开始

  1. 通过 JitPack 下载库并将其添加为依赖项。
  2. 创建 GUIManager 实例并从 menus/ 文件夹加载菜单。
  3. 使用 Java 类描述数据库实体,标记主键 @PrimaryKey,并在 DynamicDatabase 中注册它们。
  4. 使用提供的命令、物品和配置 API —— 所有功能均可从命名空间 io.github.chi2l3s.nextlib.api 访问。
public final class NextTrapsPlugin extends JavaPlugin {
    private DynamicDatabase database;
    private GuiManager guiManager;

    @Override
    public void onEnable() {
        database = DatabaseManager.createDynamicDatabase(this, "jdbc:mysql://localhost:3306/nexttraps", config -> {
            config.setUsername("root");
            config.setPassword("password");
            config.setMaximumPoolSize(10);
        });

        database.register(PlayerEntity.class);

        guiManager = new GuiManager(this);
        guiManager.loadFromFolder(new File(getDataFolder(), "menus"));
    }
}

核心模块

Command API

  • 通过子命令和权限组织命令结构。
  • 支持自动补全和别名。
  • 在 OnEnable() 中只需一行即可连接。
getCommand("nextlib").setExecutor(new RootCommand());

Item API

  • 用于 ItemStack 的 Fluent 构建器,支持自定义名称、描述、标志和 PersistentDataContainer。
  • 支持设置头颅拥有者及批量修改元数据。
ItemStack reward = new ItemBuilder(Material.DIAMOND)
.setName("&B Reward of the day")
.setLore(List.of("&7 Press to get"))
        .addPersistentTag("reward", PersistentDataType.STRING, "daily")
        .glow()
        .build();

Color API

  • 单一格式化方法,将 & 和 HEX (&#RRGGBB) 转换为带颜色的消息。
player.SendMessage(color.format("Welcome to &#3498dbNextLib"));

Config Manager

  • BaseConfig 基类自动创建和更新 YAML 文件。
  • 数据加载到 Java 字段或 DTO 中。

动态数据库

  • 使用熟悉的 Java 类定义实体。
  • @PrimaryKey 注解标记主键字段。
  • DynamicTable 提供 findFirst、findMany、create、update 和 delete 方法。
@AllArgsConstructor
@Getter
public class PlayerEntity {
    @PrimaryKey
    private final UUID playerId;
    private final String nickname;
    private final String trapSkinId;
}

DynamicTable<PlayerEntity> players = database.table(PlayerEntity.class);

String trapSkinId = players.findFirst()
        .where("playerId", playerId)
        .execute()
        .map(PlayerEntity::getTrapSkinId)
        .orElse("fallback");

更多信息请参阅单独的手册 docs/dynamic-database.md。


GUI API 与条件

  • 菜单由 plugins/<Your login >/menus 目录下的 YAML 文件定义。
  • slot 字段接受单个值,而 slots 是一个包含任意槽位或范围(如 A-B)的列表。
  • 你可以注册自己的条件(Conditions#register),并使用它们来高亮显示对象或限制交互。
  • 内置操作:close、command、console、message、opengui、update、playsound。
id: traps
title: "&8 Trap Selection"
size: 54
items:
  back:
    material: ARROW
    slot: 53
    name: "&7node"
onLeftClick:
      - "opengui main"
  trap:
    material: TRIPWIRE_HOOK
    slots:
      - 0-8
      - 18
    name: "&b%trap_name%"
    lore:
      - "&7 Cost: &e%price%"
enchanted_when:
      - "selected"
    onLeftClick:
      - "update"
      - "playsound ENTITY_ENDER_DRAGON_AMBIENT 0.7 1.2"

有关详细指南和示例,请参阅 docs/gui—conditions.md。


配置文件的处理

  • 继承自 BaseConfig 以获取自动的文件创建和更新功能。
  • 使用 loadValues() 读取数据并将其与领域中的对象关联。
public class TrapSkinsConfig extends BaseConfig {
    @Override
    protected void loadValues() {
        ConfigurationSection skins = config.getConfigurationSection("skins");
        // 将 YAML 转换为你的 TrapSkin 对象
    }
}

有用链接

  • NextLib v1.0.5 Release Notes
  • Dynamic Database Guide
  • GUI Conditions and Actions Guide

路线图

  • Command API
  • Item API
  • Color API
  • Config Manager
  • GUI API with conditions and slot ranges
  • Dynamic database with HikariCP
  • Expandable GUI action registry
  • Redis/Message Queue integration
  • Utilities for working with events

许可证

MIT License © 2025 NextGenTech


你是这个资源的作者?登录后可认领此资源。

评论 0

0.0
暂无评分
5 星
0
4 星
0
3 星
0
2 星
0
1 星
0
我的评分

登录后参与评分

还没有评论,来抢沙发吧

评论配图

相似资源