 |
👈 点击左侧按钮加入官方 Discord 服务器！ |
点击右侧按钮加入官方 QQ 群！ 👉 |
 |
服主使用方法
插件下载地址 <--- 下载请点它
下载后，关闭服务器，将文件放入服务器目录/plugins 文件夹下，启动服务器。
请将PAPI和Vault也放入插件文件夹。
第一次启动会下载插件所需依赖（仅需下载一次），下载完成之后需要再重启一次，即可启用插件。
本插件是一个前置插件，不包含任何实质功能，需下载模块或其他插件拓展功能。
希望我的插件能够帮到你的插件开发！
详细开发文档
下面的内容可能更新不够及时，请以上面的详细开发文档为准！
注解驱动的
UltiTools-API改变了插件开发的方式，通过引入注解等高级语法，让你的插件开发更加高效。
通过使用UltiTools-API，你再也无需手动注册指令和监听器，只需要在你的指令类和监听器类上添加注解，UltiTools-API会自动帮你注册。
你可以像写一个控制器一样，再也不需要为一个命令做繁琐的判断，只需要在你的指令方法上添加注解，UltiTools-API会自动帮你将指令匹配到对应的方法上。还可以实现限定指令的权限，执行锁，命令冷却时间，命令Tab补全的自动生成等等。
@CmdTarget(CmdTarget.CmdTargetType.PLAYER)
@CmdExecutor(alias = {"lore"}, manualRegister = true, permission = "ultikits.tools.command.lore", description = "物品Lore编辑功能")
public class LoreCommands extends AbstractCommendExecutor {
@CmdMapping(format = "add <lore...>")
public void addLore(@CmdSender Player player, @CmdParam("lore...") String[] lore) {
...
}
@CmdMapping(format = "delete <position>")
public void deleteLore(@CmdSender Player player, @CmdParam("position") int position) {
...
}
@CmdMapping(format = "edit <position> <lore...>")
public void editLore(@CmdSender Player player, @CmdParam(value="position", suggest="[位置]") int position, @CmdParam("lore...") String[] lore) {
...
}
}
数据存储方面，UltiTools提供了Mysql、SQLite和Json的封装API，由服主决定存储方式，而你只需一套代码即可搞定所有三种存储方式。
例如
@Data
@Table("economy_accounts")
public class AccountEntity extends AbstractDataEntity {
@Column("name")
private String name;
@Column(value = "balance", type = "FLOAT")
private double balance;
@Column("owner")
private String owner;
}
//检查玩家账户是否存在
public boolean playerHasAccount(UUID player, String name) {
DataOperator<AccountEntity> dataOperator = UltiEconomy.getInstance().getDataOperator(AccountEntity.class);
return dataOperator.exist(
WhereCondition.builder().column("name").value(name).build(),
WhereCondition.builder().column("owner").value(player.toString()).build()
);
}
配置文件方面，UltiTools让你可以像操作对象一样读取配置文件。
例如
@Getter
@Setter
@ConfigEntity(path = "config/config.yml")
public class EcoConfig extends AbstractConfigEntity {
@ConfigEntry(path = "interestRate", comment = "利率，利息 = 利率 × 本金")
private double interestRate = 0.0003;
public EcoConfig(String configFilePath) {
super(configFilePath);
}
}
// 获取经济插件的配置文件，并且读取利息率
EcoConfig config = UltiEconomy.getInstance().getConfig(EcoConfig.class);
double intrestRate = config.getInterestRate();
IOC容器管理
UltiTools-API提供了一个Spring IOC容器，它可以帮你管理你的插件中的所有Bean，并且自动注入依赖。
// @Service将类型标记为一个Bean，UltiTools-API会自动扫描并注册
@Service
public class BanPlayerService {
...
public void unBanPlayer(OfflinePlayer player) {
DataOperator<BanedUserData> dataOperator = BasicFunctions.getInstance().getDataOperator(BanedUserData.class);
dataOperator.delById(player.getUniqueId().toString());
}
}
@CmdTarget(CmdTarget.CmdTargetType.BOTH)
@CmdExecutor(permission = "ultikits.ban.command.all", description = "封禁功能", alias = {"uban"}, manualRegister = true)
public class BanCommands extends AbstractCommendExecutor {
// 使用@Autowired注解，UltiTools-API会自动注入依赖
@Autowired
private BanPlayerService banPlayerService;
@CmdMapping(format = "unban <player>")
public void unBanPlayer(@CmdSender CommandSender sender, @CmdParam("player") String player) {
banPlayerService.unBanPlayer(Bukkit.getOfflinePlayer(player));
sender.sendMessage(BasicFunctions.getInstance().i18n("§a解封成功"));
}
...
}
如果你不喜欢自动注入，或者无法使用自动注入，你也可以手动获取Bean。
BanPlayerService banPlayerService = getContext().getBean(BanPlayerService.class);
提供超多的现代化依赖库
UltiTools-API提供了Hutool的部分功能，包括了大量的工具类。
Hutool 文档
GUI界面方面，UltiTools提供了obliviate-invs的API，方便你快速的开发GUI界面。
ObliviateInvs — Highly efficient modular GUI library
UltiTools也提供了Adventure的API。
Adventure 文档
快速开始
更多详细文档请查看 UltiTools API 文档
以下是简单的快速开始
安装依赖
首先将UltiTools-API依赖加入到你的项目
使用Maven
<dependency>
<groupId>com.ultikits</groupId>
<artifactId>UltiTools-API</artifactId>
<version>6.1.1</version>
</dependency>
使用Gradle
implementation 'com.ultikits:UltiTools-API:6.1.1'
开始之前请在resources文件夹下新建一个plugin.yml文件，内容如下
# 插件名称
name: TestPlugin
# 插件版本
version: '${project.version}'
# 插件主类
main: com.test.plugin.MyPlugin
# 插件用到的UltiTools-API版本，例如6.0.0就是600
api-version: 600
# 插件作者
authors: [ wisdomme ]
新建一个config文件夹，里面可以按照你的需求放入你的插件配置文件。这些配置文件会被原封不动的放入UltiTools插件的集体配置文件夹中展示给用户。
简单开发
新建一个主类继承UltiToolsPlugin，类似传统的Spigot插件，UltiTools插件也需要重写启动和关闭方法。
但是UltiToolsPlugin增加了一个可选的UltiToolsPlugin#reloadSelf()方法，用于插件重载时执行。
给主类加上UltiToolsModule注解，即可开启监听器、命令和依赖的自动扫描注册。
@UltiToolsModule
public class MyPlugin extends UltiToolsPlugin {
@Override
public boolean registerSelf() {
// 插件启动时执行
return true;
}
@Override
public void unregisterSelf() {
// 插件关闭时执行
}
@Override
public void reloadSelf() {
// 插件重载时执行
}
}
这样就已经完成了一个什么功能都没有的UltiTools插件。然后你就可以直接开始写命令执行器或者监听器啦！
事件监听器
只要在类上加上 @EventListener 注解并实现 Listener 类即可被UltiTools自动发现并且注册为事件监听器，无需手动注册！
@EventListener
public class JoinListener implements Listener {
@EventHandler
public void onPlayerJoin(PlayerJoinEvent event) {
// 干一些好玩的事情
}
}
命令执行器
在类上加上 @CmdExecutor 和 @CmdTarget 注解并继承 AbstractCommendExecutor 类即可被UltiTools自动发现并且注册为命令，也是无需手动注册！
@CmdExecutor(description = "Bank", alias = {"bank"})
@CmdTarget(CmdTarget.CmdTargetType.PLAYER)
public class BankCommand extends AbstractCommendExecutor {
@CmdMapping(format = "list")
public void listAccounts(@CmdSender Player player) {
List<AccountEntity> banks = bank.getOwnedAccounts(player.getUniqueId());
if (banks.isEmpty()) {
player.sendMessage(UltiEconomy.getInstance().i18n("你没有任何银行账户"));
}
player.sendMessage(UltiEconomy.getInstance().i18n("你的银行账户列表:"));
for (AccountEntity bankName : banks) {
player.sendMessage(" - " + bankName + " : " + bank.checkAccountBalance(player.getUniqueId(), bankName.getName()));
}
}
}
模块安装
写完以上代码之后，使用mvn package命令打包，生成的jar文件放入 服务器根目录/plugins/UltiTools/plugins 文件夹中，重启服务器模块即可生效！
使用命令 ul list 查看是否成功加载。
> ul list
[12:42:16] [Server thread/INFO]: BasicFunctions 1.0.0
[12:42:16] [Server thread/INFO]: UltiTools-Login 1.0.0
[12:42:16] [Server thread/INFO]: UltiTools-MysqlConnector 1.0.0
[12:42:16] [Server thread/INFO]: UltiTools-SidebarPlugin 1.0.0
[12:42:16] [Server thread/INFO]: Example 1.0.0 <--- 这是我们的示例插件
主要贡献者
发现问题？想提建议？
点击这里提交开启一个Issue！
鸣谢
|
|
 |
记录了我们开发途中的每一刻 |
 |
地表最强 Java IDE 助力愉悦开发体验 |
 |
帮助解决了许多重复且枯燥的工作 |
 |
为插件带来了许多黑科技 |
 |
官方构建工具 |
人气
金粒
宝石
爱心
钻石
贡献
发表于 2024-7-2 15:27:13
提升卡
沉默卡
喧嚣卡
变色卡
千斤顶
开盒卡
楼主
