StarItems

插件

· 作者 Firestar311

一个用于创建自定义物品的简单库(目前仅限开发者使用)

0 本站下载 0 关注 更新于 11 个月前

需要前置:NBT-API

最新 0.5.0 · 1.21.10 · Bukkit / Paper

一键开服(送7天)

⚠️ StarItems 目前是一个作为开发者工具使用的插件。它不像其他物品插件那样允许你通过命令或文件来配置物品。我正在随着我在其他项目中处理物品的经验,逐步完善这一功能。

自 StarItems v0.3.0 起,它已成为一个独立插件,不应再与 StarCore 一起使用,因为现在 StarCore v0.13.0 已内置了 StarItems。如果你是一名开发者并使用 StarCore,在更新后你就不需要这个插件了。 这使得开发者拥有更大的灵活性,无需同时依赖 StarCore 和 StarItems。

总共有三种构建产物(Artifacts):

  • 依赖包 Artifact:这是基础产物,也是用于发布 Maven 依赖的版本。请使用此版本进行开发对接。
  • 插件包 Artifact:这是一个插件产物,但它不包含所有必需的依赖项,需与其他库插件(如 StarMCLib)配合使用。此版本仅包含 StarItems 代码和 StarDevLLC ItemBuilder 库。
  • 独立包 Artifact:这就是你在 SpigotMC 上下载的产物,是一个完全独立的版本,将所有必需的依赖项打包进了插件中。

必需依赖

Java 21
NBT-API 2.15.3

不兼容项(适用于从 Modrinth 下载的版本)

  • StarMCLib
  • StarCore
  • StarEvents

版本信息

本插件仍在开发中且非常不稳定。我正在不断地向本插件中添加、更改和移除内容。这些改动基于我在其他项目中的需求,而那些项目也处于持续开发和演变的过程中。随着时间的推移,情况预计会逐渐稳定下来。

基本信息

StarItems 是一个提供自定义物品底层支持的插件。它使用 NBT 标签来检测物品是自定义物品还是普通物品。 这不是面向服务器管理员的插件,而是面向开发者的。随着时间的推移,它将提供一些面向服务器管理员的默认功能。

安装 - 服务器管理员

下载插件并将其放入你的 plugins 文件夹,然后重启服务器以应用所有更改。

安装 - 插件开发者

强烈建议使用 Gradle 或 Maven 等构建工具。你可以在构建工具中找到填写所需配置的详细信息。

  • 仓库地址:
  • Group ID: com.github.StarDevelopmentLLC
  • Artifact ID: StarItems
  • Version: 0.5.0

对于 Gradle,应设置为 compileOnly;对于 Maven,应设置为 provided 作用域,因为它是一个插件。

命令 - /staritems

这是 StarItems 的主要管理命令。目前它的功能很少,但随着功能的增加,会有更多命令加入。 权限:staritems.admin

/staritems list

此命令列出当前注册到 StarItems 的所有物品,以及拥有这些物品的插件。 权限:staritems.admin.list

/staritems give <name> [amount]

此命令允许你给自己发放一个自定义物品。<name> 是 list 命令中列出的名称,[amount] 是一个可选参数,默认为 1。 权限:staritems.admin.give

用法 - 插件开发者

ItemBuilder 类用于构建物品并提供物品配置。

ItemBuilder itemBuilder = ItemBuilder.of(XMaterial.DIAMOND);

接下来,我们要创建一个自定义物品实例,传入插件、名称和 itembuilder。 物品的名称即为其“ID”,插件会自动重新格式化名称以使其正常工作。

CustomItem customItem = new CustomItem(plugin, "custom_diamond", itemBuilder);

然后,我们需要获取 ItemRegistry 并将自定义物品注册到其中。 注意:每个自定义物品只注册一次。最好将其存储在某种静态字段中,或者使用注册表来获取该物品。

ItemRegistry itemRegistry = StarItems.getItemRegistry();
itemRegistry.register(customItem);

我们可以使用 toItemStack 方法将自定义物品添加到玩家的背包中。

player.getInventory().addItem(customItem.toItemStack());

不要使用 ItemBuilder 实例直接添加物品。toItemStack 方法会将名称作为 NBT 字符串添加到物品堆栈中。如果不存在该名称,库将无法通过消费者检测到它。

StarItems 提供了根据特定操作向物品附加消费者的能力。请查看 CustomItems 类中的消费者字段。 StarItems 会自动处理这些逻辑,并将事件/玩家传递给消费者。 基于事件的消费者仅在物品匹配且事件发生时调用。 非事件类的消费者每秒检查一次。建议将药水效果等内容的设置值调低,我发现测试中将它们设置为 2 秒(40 tick)是可以正常工作的。 由于夜视效果有闪烁现象,你需要将此值设置得更高一些。


本插件免费提供给用户,并在 MIT 开源许可证下发布。我绝不会在任何地方出售此库。如果你发现有人在售卖,那不是我本人所为,请直接向我报告此类情况。本库仅在 GitHub Release 和 SpigotMC 上发布,其他来源的使用风险自负。

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

评论 0

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

登录后参与评分

还没有评论,来抢沙发吧

评论配图

相似资源