Merge pull request #8 from pingguo114514/main

增加了导出API的文档

docs/_sidebar.md

@@ -8,5 +8,6 @@
 [开发指南](/subpages/develop.md)
 [Event事件文档](/subpages/Event.md)
 [API指南](/subpages/API.md)
+[导出API指南](/subpages/LLAPI.md)
 [Sparkbridge1指南](https://sparkbridge.github.io/docs/)
 [关于我们](/subpages/about.md)

docs/subpages/Event.md

@@ -55,7 +55,7 @@ spark.on('message.private.friend', (e, reply) => {
 ### bot.online
 
 ```js
-spark.QClient.on('bot.online', () => { //当bot登录时
+spark.on('bot.online', () => { //当bot登录时
     spark.QClient.sendGroupMsg(spark.mc.config.group, '我来啦');向指定群发送字符
 });//bot上线时执行的命令
 

docs/subpages/LLAPI.md

@@ -0,0 +1,202 @@
+# Spark 导出API文档
+
+使用导出API，你可以在其他LSE插件甚至原生插件中调用SparkAPI
+
+**API仅支持sparkbridge 2.3.4以上，事件仅支持sparkbridge 2.3.5以上**
+
+## API
+
+要使用sparkbridge提供的导出API，你需要使用[LSE的导入函数接口](https://lse.liteldev.com/zh/apis/ScriptAPI/Ll/#_6)，并将sparkbridge2设为插件依赖项或将导入函数部分放至[服务器启动完毕后](https://lse.liteldev.com/zh/apis/EventAPI/OtherEvents/#onserverstarted-)
+
+如无特殊说明，sparkbridge提供的导出API的命名空间均为'SparkAPI'
+
+### GetGroupId()
+
+函数的导出名称:`GetGroupId`
+
+获取配置文件中的群号
+
+- **参数:无**
+
+- **返回值:配置文件中的群号，即sparkbridge插件中的spark.mc.config.group**
+
+### QQ 发送 API
+
+#### sendGroupMsg(gid, msg) 
+
+函数的导出名称:`sendGroupMsg`
+
+发送一个群信息
+
+- **参数：**
+  - `gid`：群ID。
+  - `msg`：信息内容。
+
+#### sendPrivateMsg(fid, msg)
+
+函数的导出名称:`sendPrivateMsg`
+
+发送一个私信信息
+
+- **参数：**
+  - `fid`：好友ID。
+  - `msg`：信息内容。
+
+#### sendGroupForwardMsg(gid, msg)
+
+函数的导出名称:`sendGroupForwardMsg`
+
+发送群合并聊天信息
+
+- **参数：**
+  - `gid`：群ID。
+  - `msg`：自定义转发消息, 具体看 [CQcode](https://docs.go-cqhttp.org/cqcode/#%E5%90%88%E5%B9%B6%E8%BD%AC%E5%8F%91%E6%B6%88%E6%81%AF%E8%8A%82%E7%82%B9)。
+
+
+#### deleteMsg(id)
+
+函数的导出名称:`deleteMsg`
+
+撤回某个信息
+
+- **参数：**
+  - `id`：信息id
+
+### sendWSPack(msg)
+
+函数的导出名称:`sendWSPack`
+
+发送一条websocket消息
+
+- **参数：**
+  - `msg`：要发送的websocket消息
+
+### Msgbuilder API
+
+#### img(file)
+
+函数的导出名称:`msgbuilder.img`
+
+返回表示图片消息的对象。
+
+- **参数：**
+  - `file`（字符串 | Buffer）：图片文件的路径或图片缓冲区。
+
+- **返回值：** 
+  包含图片数据的对象。
+
+#### at(qid)
+
+函数的导出名称:`msgbuilder.at`
+
+返回表示 @提及 消息的对象。
+
+- **参数：**
+  - `qid`（字符串）：QQ ID。
+
+- **返回值：** 
+  包含 @提及 数据的对象。
+
+#### face(id)
+
+函数的导出名称:`msgbuilder.face`
+
+返回表示表情消息的对象。
+
+- **参数：**
+  - `id`（字符串）：表情 ID。
+
+- **返回值：** 
+  包含表情数据的对象。
+
+#### text(raw)
+
+函数的导出名称:`msgbuilder.text`
+
+返回表示文本消息的对象。
+
+- **参数：**
+  - `raw`（字符串）：原始文本。
+
+- **返回值：** 
+  包含文本数据的对象。
+
+#### poke(id)
+
+函数的导出名称:`msgbuilder.poke`
+
+返回表示戳一戳消息的对象。
+
+- **参数：**
+  - `id`（字符串）：QQ ID。
+
+- **返回值：** 
+  包含戳一戳数据的对象。
+
+#### reply(id)
+
+函数的导出名称:`msgbuilder.reply`
+
+返回表示回复消息的对象。
+
+- **参数：**
+  - `id`（字符串）：回复 ID。
+
+- **返回值：** 
+  包含回复数据的对象。
+
+
+#### format(msg)
+
+函数的导出名称:`msgbuilder.format`
+
+格式化消息以确保其结构正确。
+
+- **参数：**
+  - `msg`（字符串 | 对象 | 数组）：要格式化的消息（们）。
+
+- **返回值：** 
+  格式化后的消息。
+
+#### ForwardMsgBuilder()
+
+函数的导出名称:`msgbuilder.ForwardMsgBuilder`
+
+返回 ForwardMsgBuilder 的新实例。
+
+- **返回值：** 
+  ForwardMsgBuilder 的新实例。
+
+
+## 事件
+
+**要使用事件，你需要将sparkbridge2设为插件依赖项**
+
+使用事件API需要导入Spark模块，导入示例:
+
+```javascript
+const { Spark } = require('./sparkbridge2/plugins/llapi/lib/EventAPI');
+```
+### 使用方法
+
++ 类似LSE自带事件使用方法，但此处使用Spark类
+
+```javascript
+Spark.on("事件名称",(a,b,c,.....)=>{
+    ...
+});
+```
+事件名称同sparkbridge插件，详见[事件文档](/subpages/Event.md)
+
+注意:导出API中的事件不可以使用回调函数中的reply参数，要回复消息请使用msgbuilder
+
+## Example
+
+```javascript
+const { Spark } = require('./sparkbridge2/plugins/llapi/lib/EventAPI');
+const sendGroupMsg=ll.imports('SparkAPI','sendGroupMsg');
+const GetGroupId=ll.imports('SparkAPI','GetGroupId');
+Spark.on("bot.online",()=>{
+    sendGroupMsg(GetGroupId(),'服务器已启动');
+});
+```