开发概述
ArcartX服务端插件开发入门
写在前面
- ArcartX 提供了完整的服务端 API,允许第三方插件与 ArcartX 深度集成。你可以通过 API 控制模型、特效、UI、按键绑定、音效等几乎所有客户端功能。
- 本章节面向有 Java/Kotlin 开发经验的插件开发者。如果你只是想通过配置文件使用 ArcartX 的功能,请参阅核心教学部分。
环境要求
- Java 17+
- Kotlin 1.8.22+(如果使用 Kotlin 开发)
- 服务端需安装 ArcartX 插件
引入依赖
使用 AX API 时,引用与服务端配套的 ArcartX 编译依赖即可。附属插件不需要因此使用 AX 的内部框架,也不要将另一份 AX API 打包进自己的成品。
在你的 plugin.yml 中添加依赖声明:
或者作为软依赖:
将 ArcartX 的 jar 文件添加到项目的编译依赖中即可使用 API。
获取API入口
- 常用 API 可通过
ArcartXAPI的静态方法取得,各模块的详细合同见对应页面。
注意事项
- 请确保在 ArcartX 加载完成后再调用 API,建议在你插件的
onEnable中使用。 - 部分 API 涉及网络数据包发送,请注意线程安全问题,涉及 Bukkit API 的操作需要在主线程执行。
- ArcartX 的实体管理器会自动清理过期的实体缓存,你不需要手动管理实体对象的生命周期。
