VSCode的安装
VSCode是微软开发的免费开源的代码编辑器,支持多种语言,支持插件扩展..... 后面忘了
如果你要开发EasyBot插件,那么我推荐你使用VSCode或类似的工具进行开发。
新建文件夹并创建插件声明文件
为了方便在EasyBot中使用热重载功能,在开发时我们建议你直接在EasyBot的插件目录下进行开发。
%EasyBot安装目录%/plugins
下为安装目录
在EasyBot目录下新建一个文件夹,例如test
,然后在该文件夹下创建一个manifest.json
文件,内容如下:
{
"name": "测试插件",
"version": "1.0.0",
"plugin_id": "my_test_plugin",
"author": "MiuxuE",
"description": "这是一个测试插件,这是我写的第一个插件!",
"tags": ["测试"],
"entry": "main.js",
"contents": "# 你好世界\n 你好,这是我写的第一个**插件**!",
"links": [
{
"name": "教程",
"url": "https://docs.inectar.cn/docs/easybot/develop/plugin/tutorial/start"
}
]
}
创建入口文件
在刚才创建的文件夹内创建一个main.js
文件,内容如下:
logger.info("插件被加载");
bus.on('enable', () => {
logger.info("插件被启用");
});
bus.on('disable', () => {
logger.info("插件被禁用");
});
在EasyBot中加载插件
由于你在开发时是在EasyBot的插件目录下进行的,在这之前EasyBot没有从目录中识别到该插件,你需要在第一次写完时重启EasyBot才能让EasyBot识别到该插件。
如果你完成了上面的步骤, 在重启后你会看到控制台输出了插件被加载
的信息。
在启用或禁用插件后你会看到对应的信息
获取代码提示
你或许已经注意到了,在你写代码时,你无法通过现代化的IDE获得代码提示,这是因为EasyBot的插件系统是基于ClearScript
的,我们现在需要指定EasyBot
的SDK作为引用,告诉编辑器我们有哪些接口。
下载SDK
从我们的下载站下载一个最新版本的SDK压缩包解压到根目录下
下载后解压,目录类似这样:
添加引用
打开main.js
文件,在顶部添加一行代码:
/// <reference path="easybot-sdk/easybot.d.ts" />
保存后你就可以获得代码提示了。
发布和打包
当你完成开发后,可以直接将插件打包为zip发给其他人使用。
打包时需要注意,插件压缩包的根目录必须为manifest.json
所在的目录,否则会报错。
easybot-sdk
仅用作代码提示、你可以在发布的时候删除该目录,该操作不会影响插件运行。
重载插件
当你修改了插件后,你需要重新加载插件才能使修改生效。
点击EasyBot的控制台左下角的刷新按钮即可重载插件。
下一步
恭喜你完成了第一个EasyBot插件!当你的插件变得更加复杂时,你可能需要将代码分割成多个文件来提高可维护性。