从 Paper 插件开发中提取的工具库 —— 这样你就不用每个插件都重复编写相同的样板代码。
仓库
<repository>
<id>jitpack.io</id>
<url>https://jitpack.io</url>
</repository>
依赖
<dependency>
<groupId>com.github.Hikari16665</groupId>
<artifactId>HikariLib</artifactId>
<version>master-SNAPSHOT</version>
</dependency>
需要 Paper 1.21.1 和 Java 21。
内容概览
菜单系统
使用字符矩阵定义菜单布局:
HikariMatrixDrawer drawer = new HikariMatrixDrawer(9)
.addLine("XXX XXXX")
.addLine(" X X X")
.addExplain('X', new ItemStack(Material.STONE), (event, slot, menu) -> {
event.getWhoClicked().sendMessage("Clicked stone!");
});
HikariMenu menu = new HikariMatrixDrawer.Builder()
.withTitle("&6Example Menu")
.withRows(3)
.withDrawer(drawer)
.build();
menu.open(player);
如果需要自定义绘制逻辑,请实现 HikariMenuDrawer。
聊天输入
询问玩家一个问题并等待回复,支持可配置的超时时间:
// 默认 30 秒超时
ChatAsk.ask(player, "Enter your name:", name -> {
player.sendMessage("Hello, " + name);
});
// 10 秒超时
ChatAsk.ask(player, "Enter the code:", code -> {
// ...
}, 10000);
数据库
通用的 DataBaseConnection 接口。MySQL 和 SQLite 均内置了 HikariCP 连接池:
DataBaseConnection db = new MySQLConnection("localhost", 3306, "mydb", "root", "pass", false);
// 或 new SQLiteConnection("plugins/xxx/data.db")
db.query("SELECT * FROM users WHERE age > ?", 18);
db.insert("users", null, "Alice", 25);
db.transaction(() -> {
db.execute("UPDATE accounts SET balance = balance - 100 WHERE id = ?", 1);
db.execute("UPDATE accounts SET balance = balance + 100 WHERE id = ?", 2);
return null;
});
调度器
编写一次,同时兼容 Bukkit 和 Folia:
HikariScheduler.addTimedTask(20, () -> player.sendMessage("Hello"), false);
HikariScheduler.addRepeatingTask(20, () -> player.sendMessage("Tick"), false);
ItemStack 构建器
链式创建物品:
HikariItemStack item = new HikariItemStack(Material.DIAMOND_SWORD)
.setName("&6Legendary Sword")
.setLore(List.of("&7A sword of legend"))
.setCustomModelData(1001);
player.getInventory().addItem(item.getItem());
反射
一行代码完成反射调用:
ReflectionUtil.setField(obj, "someField", newValue);
String result = ReflectionUtil.callMethod(String.class, obj, "methodName", arg1, arg2);
位置与传送
// 获取位置所在的区块
Chunk chunk = LocationUtils.getChunk(location);
// 获取区块内的方块位置(0-15 偏移量)
Location loc = LocationUtils.getChunkOffsetLocation(chunk, 5, 64, 5);
// 传送玩家(在 Folia 上始终异步,在 Bukkit 上可配置)
LocationUtils.teleportPlayer(player, targetLocation); // 同步
LocationUtils.teleportPlayer(player, targetLocation, true); // Bukkit 上异步
实体工具
在实体的调度器上运行任务。在 Folia 上会自动通过实体调度器执行:
EntityUtil.runAsEntity(player, () -> {
player.openInventory(menu);
});
过期 HashMap
条目在配置的时间后自动过期 —— 无需手动清理:
// 60 秒 TTL
ExpiringHashMap<UUID, String> cache = new ExpiringHashMap<>(60000);
cache.put(playerId, "some data");
String data = cache.get(playerId); // 尚未过期 —— 返回数据
String gone = cache.get(playerId); // 60 秒后 —— 返回 null
// 完成后关闭后台清理线程
cache.close();
服务器环境
检测服务器平台,避免下游代码进行分支判断:
if (ServerEnvironment.isFolia()) {
// 使用 Folia 特定的调度
} else {
// 使用 Bukkit 调度
}
String version = ServerEnvironment.getMinecraftVersion();
String bukkitVersion = ServerEnvironment.getBukkitVersion();
String name = ServerEnvironment.getName();
// 完整的服务器元数据
ServerEnvironment.ServerMeta meta = ServerEnvironment.getMeta();
System.out.println(meta.getMotd());
System.out.println(meta.getMaxPlayers());
构建
mvn clean package
本地安装
mvn install
然后将 jar 文件放入 Paper 服务器的 plugins/ 目录中。
许可证
MIT
你是这个资源的作者?登录后可认领此资源。
相似资源
PacketEvents 是一款专为 Minecraft Java 版打造的协议库,旨在简化数据包的处理与传输。
ExyliaPlugins 的库。
通过对话框或铁砧界面帮助你的 Anthme
重新定义服务器上的生物运输方式。使用高度可定制的口袋道具,安全地捕获、存储和释放任何实体。
为基于 Spigot/Paper/Folia 的服务器添加对 Vivecraft 的支持
用于绘制游戏内地图或在浏览器中随探索实时进行地图绘制的实时地图。
评论 0
登录后参与评分
还没有评论,来抢沙发吧