引入依赖
API 的类已经打包在 CarryYou 插件主 jar 里,所以你可以直接拿主 jar 当依赖,也可以单独使用 plugin-api 模块构建出来的 jar。
获取 jar 包
方式一:直接使用插件 jar(推荐)
下载 CarryYou jar,丢到你的项目的 libs 文件夹里。
因为插件打包时会把 plugin-api 一起打进去,主 jar 里本身就包含完整的 API 类。
方式二:构建 plugin-api模块产生的jar (你真的要这么干吗)
如果你有 CarryYou 的源码,也可以单独构建 API 模块:
bash
./gradlew :plugin-api build构建产物在 plugin-api/build/libs/。
添加依赖
Gradle
把 jar 放到项目的 libs 文件夹后:
kotlin
dependencies {
compileOnly(files("libs/CarryYou-2.5.jar"))
// 或者用单独构建的 API jar
// compileOnly(files("libs/plugin-api-2.5.jar"))
}Java 版本
CarryYou 以 Java 17 编译,你的项目也需要使用 JDK 17 及以上 才能正常编译。
在 plugin.yml 中声明依赖
为了让你的插件在 CarryYou 之后加载(API 在 CarryYou 的 onLoad 阶段就注册好了),需要在 plugin.yml 中声明依赖:
yml
# 你的 plugin.yml
depend: [CarryYou]
# softdepend: [CarryYou]获取 API 实例
所有 API 的入口都是 CarryyouAPI 这个类:
java
import carryyou.api.CarryyouAPI;
import carryyou.api.CarryManagerAPI;
public class MyPlugin extends JavaPlugin {
@Override
public void onEnable() {
CarryManagerAPI api = CarryyouAPI.getCarryManager();
if (api == null) {
// 说明 CarryYou API 还没注册
getLogger().warning("CarryYou 未安装或版本过低,无法使用 API!");
return;
}
// 拿到 api 之后想干什么都可以啦
}
}拿到 CarryManagerAPI 之后,具体怎么用请看 CarryManager API 和 事件。