onebots 0.0.15 → 0.0.16

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2022 凉菜
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2022 凉菜
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,63 +1,84 @@
-<div align="center">
-    <h1>基于oicq的oneBot实现</h1>
-    <p>
-
-[![dm](https://shields.io/npm/dm/onebots)](https://www.npmjs.com/package/onebots)
-[![oneBot V11](https://img.shields.io/badge/OneBot-11-black?logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAHAAAABwCAMAAADxPgR5AAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAAAxQTFRF////29vbr6+vAAAAk1hCcwAAAAR0Uk5T////AEAqqfQAAAKcSURBVHja7NrbctswDATQXfD//zlpO7FlmwAWIOnOtNaTM5JwDMa8E+PNFz7g3waJ24fviyDPgfhz8fHP39cBcBL9KoJbQUxjA2iYqHL3FAnvzhL4GtVNUcoSZe6eSHizBcK5LL7dBr2AUZlev1ARRHCljzRALIEog6H3U6bCIyqIZdAT0eBuJYaGiJaHSjmkYIZd+qSGWAQnIaz2OArVnX6vrItQvbhZJtVGB5qX9wKqCMkb9W7aexfCO/rwQRBzsDIsYx4AOz0nhAtWu7bqkEQBO0Pr+Ftjt5fFCUEbm0Sbgdu8WSgJ5NgH2iu46R/o1UcBXJsFusWF/QUaz3RwJMEgngfaGGdSxJkE/Yg4lOBryBiMwvAhZrVMUUvwqU7F05b5WLaUIN4M4hRocQQRnEedgsn7TZB3UCpRrIJwQfqvGwsg18EnI2uSVNC8t+0QmMXogvbPg/xk+Mnw/6kW/rraUlvqgmFreAA09xW5t0AFlHrQZ3CsgvZm0FbHNKyBmheBKIF2cCA8A600aHPmFtRB1XvMsJAiza7LpPog0UJwccKdzw8rdf8MyN2ePYF896LC5hTzdZqxb6VNXInaupARLDNBWgI8spq4T0Qb5H4vWfPmHo8OyB1ito+AysNNz0oglj1U955sjUN9d41LnrX2D/u7eRwxyOaOpfyevCWbTgDEoilsOnu7zsKhjRCsnD/QzhdkYLBLXjiK4f3UWmcx2M7PO21CKVTH84638NTplt6JIQH0ZwCNuiWAfvuLhdrcOYPVO9eW3A67l7hZtgaY9GZo9AFc6cryjoeFBIWeU+npnk/nLE0OxCHL1eQsc1IciehjpJv5mqCsjeopaH6r15/MrxNnVhu7tmcslay2gO2Z1QfcfX0JMACG41/u0RrI9QAAAABJRU5ErkJggg==)](https://onebot.dev/)
-[![oneBot V12](https://img.shields.io/badge/OneBot-12-black?logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAHAAAABwCAMAAADxPgR5AAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAAAxQTFRF////29vbr6+vAAAAk1hCcwAAAAR0Uk5T////AEAqqfQAAAKcSURBVHja7NrbctswDATQXfD//zlpO7FlmwAWIOnOtNaTM5JwDMa8E+PNFz7g3waJ24fviyDPgfhz8fHP39cBcBL9KoJbQUxjA2iYqHL3FAnvzhL4GtVNUcoSZe6eSHizBcK5LL7dBr2AUZlev1ARRHCljzRALIEog6H3U6bCIyqIZdAT0eBuJYaGiJaHSjmkYIZd+qSGWAQnIaz2OArVnX6vrItQvbhZJtVGB5qX9wKqCMkb9W7aexfCO/rwQRBzsDIsYx4AOz0nhAtWu7bqkEQBO0Pr+Ftjt5fFCUEbm0Sbgdu8WSgJ5NgH2iu46R/o1UcBXJsFusWF/QUaz3RwJMEgngfaGGdSxJkE/Yg4lOBryBiMwvAhZrVMUUvwqU7F05b5WLaUIN4M4hRocQQRnEedgsn7TZB3UCpRrIJwQfqvGwsg18EnI2uSVNC8t+0QmMXogvbPg/xk+Mnw/6kW/rraUlvqgmFreAA09xW5t0AFlHrQZ3CsgvZm0FbHNKyBmheBKIF2cCA8A600aHPmFtRB1XvMsJAiza7LpPog0UJwccKdzw8rdf8MyN2ePYF896LC5hTzdZqxb6VNXInaupARLDNBWgI8spq4T0Qb5H4vWfPmHo8OyB1ito+AysNNz0oglj1U955sjUN9d41LnrX2D/u7eRwxyOaOpfyevCWbTgDEoilsOnu7zsKhjRCsnD/QzhdkYLBLXjiK4f3UWmcx2M7PO21CKVTH84638NTplt6JIQH0ZwCNuiWAfvuLhdrcOYPVO9eW3A67l7hZtgaY9GZo9AFc6cryjoeFBIWeU+npnk/nLE0OxCHL1eQsc1IciehjpJv5mqCsjeopaH6r15/MrxNnVhu7tmcslay2gO2Z1QfcfX0JMACG41/u0RrI9QAAAABJRU5ErkJggg==)](https://12.onebot.dev/)
-[![node engine](https://img.shields.io/node/v/oitq?color=339933&style=flat-square&labelColor=FAFAFA&logo=Node.js)](https://nodejs.org)
-[![qq group](https://img.shields.io/badge/group-860669870-blue?style=flat-square&labelColor=FAFAFA&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAD4AAAA+CAMAAABEH1h2AAACB1BMVEX///8AAADoHx/6rgjnFhb/tQj9/f3/sggEAgLyICD//vztICAGBgbrHx8MDAwJCQn7rwj09PTi4uKbm5uBgYHvICAREREODg79sQgkJCT39/f/+/HExMT3q6tNTU37vTRFMQI4JwIgFgHt7e3r6+vd3d3b29u7u7uwsLDyenp4eHjxc3NZWVn//fj//PTf399vb29UVFQ8PDwuLi76uCUgICDfHh7oGhoYGBgVFRWjcgf6+vrR0dG2traYmJiUlJRqampiYmJXV1dDQ0M2Njbk5OTX19fKysr+5a70lJTyfX1zc3P90Gz+yFBGRkbsRET+vCn6tyLUHBwcHBzDGhqxFxesFxeeFRV4EBD/twjGiwa0fwaodgUbAwMJBgD++PjT09O/v7+xsbGpqamoqKj4p6eJiYloaGgxMTEnJyfv7+/96Ojm5ubq5eX84ODP1NTOzs7Nzc3/wcH4vb34urqioqKKioqCfXTvZWWeY2OMfmCgh1G8l0TdqjrqKirZHR3mHBy3GBiXFBSSExN/EREmERHmDg76sAxVCwtICgr/vQlECQnupwjupgjrpQg4CAjUlAfQkgfMjwbAhga7gwYiBQWJYASAWgR3UwRrSwNiRQMUAgISAgISDQEUDgD/9+X+9uX60dH3sbH94aP94aK/kZG+kJCMjIzzhobwbm7uXl7uWlrpLCyLIqc8AAAEYklEQVRIx62Wd1vaUBTGcxACmIBYRpG2LEFoRcVi0SJaLLV1a927rXV277333nvv/SF7b3JNi+Qm2KfvPyT35Pck57znXg6jKNblYpl/00brTDpWVBRLz1g3LpatnUwXgKSC9GTtYujlq2GBVi/PnT5SAFkqOJIjzEZBVtHcqrgKKFqVC30YqDqsTpesBUHmlC0mXsVsKbN4tbZEFV9PKlXHMMWrhZoXM0wdqeV6VcsMIKgB32ziAfhN+KpBXDWo2VcJotDLt9axGwA2CPWuI8uVKpmTr+Q3MsVFMJFCn8HWuyPbSniSk3L20yDhSeRUK0Dr1/S6mekgwWFasWOkZg0xO+YgjOroLsHtHpKaV6l3lpiBKIUSCQVqAGp24EAKiMxLFPAwzGvppvn+W4UtWCoFwgq4DST1WLdFDYJZ0W3WHpBkU7SNLnXrkM9EBr/3+ZPEyKOHDx+NJJ489/pJNwl9QFPhGhDkfzp8S69D0iMJv7eGn/rF2JpCKh4Qt8v4gxt6S16GLPobD8bFbROg+0YK7Bux6DJ4dDviI5bQnauQbPeO3tHpnBYBdep0d0a9kvEVKl1D8n+RuHc7z+nMu30v8QLnrd43uy9neDTu93m9Pv94xuLl3VT8ULx/8OaYASgyjN0c7I8fouLHjHYjF+8dGLx29/Erw1/cq8d3rw0O9MY59MAxGr3njEmj0Zg4u9Fuinf3nu8fuHDx4oWB/vO93XETWuSE8Jk9FLzZqPkjE8fZ7UYku53DnCRjszy9pZPT5CCuc4ssfsBoygU3GQ/I4sf7znJGzqSIogfO9h2Xo3c5YOz6pb7uc9pqObJaq9We6+67dH0MHLtkcCsIevll6ke1RBBVa351/myZ+vwSBFll8A4QtZf5oBXpzpZSpJXfmqcOvt+J67WX9EJHNh00SztqhYhrW2g70hzMwutBVE2xhK9c+ExxDXmoPgt3g3SaSDjtNAK37EGDVeSi464iAPkjJwSLwSFEOeFz+3iwyaZOSndFi3WllFK67ORdc3hb94jG7VzR3FL6vXTlQVnjerD5c66MQCMOVOIMDPsZqvZj0laJX9KYEUiigKNiOyBN0nEhvr3CgV6SzBxphE5O4iGglY63ojCfFHbH8oV4A8vU4lFsllX8C4zVMmzDQjwIHYXEPn4fDd/HE8sKOyCz69kJTDM4LYjS8CjgAjGYn2Cp86wjKE8HHapzbQC3ZUQ+FsEtHWAUFeIFDyinER9iVLQOD39hmakJD4zr6JzE84ivzzpNEM2r0+VN7YnXeHbe+vfqVjxnv060N5UrwvkfPWiWue/F51kk3MgKnjaGI2Y8MdxHM47nU74C3abTo3lCnzfqA+zgrDsScc86hHllNE8I6dro/LurQ3q902lxDlmGn/neANEb37NhyxBadur1Q1ff0t/e1Nbu8VRVbd5c1dXlOX3q5ImjR0+cPHXa09WF16o8nva2pnzl9MvKlyGVl5Xl5wtPop+y+TWC/jf9BuxZscgeRqlfAAAAAElFTkSuQmCC&logoColor=000000)](https://jq.qq.com/?_wv=1027&k=B22VGXov)
-
-[![Star History Chart](https://api.star-history.com/svg?repos=lc-cn/onebots&type=Date)](https://star-history.com/#lc-cn/onebots&Date)
-
-
-[Type Docs](https://lc-cn.github.io/onebots) 
-
-
-</p>
-</div>
-
-# 使用示例
-1. 新建一个node项目
-```shell
-npm init -y
-```
-2. 安装onebots
-```shell
-npm install onebots
-```
-3. 在项目跟目录添加配置文件config.yaml
-```yaml
-port: 6727 # 项目onebots监听的端口(默认：6727)
-1472258369: # 你的机器人账户
-  version: V11 # oneBot版本（V11 或 V12）
-```
-4. 新建入口文件`index.js`并输入一下内容
-```javascript
-const {createApp}=require('onebots')
-createApp()
-.start()
-```
-5. 启动项目
-```shell
-node ./index.js
-```
-# 使用命令行启动
-```shell
-npm install -g onebots
-onebots
-```
-# 使用接口管理oneBot
-
-| url     | method | params          | desc                           |
-|:--------| :--- |:----------------|:-------------------------------|
-| /list   | GET |                 | 获取当前运行的机器人列表                   |
-| /detail | GET | uin             | 获取指定机器人配置                      |
-| /qrcode | GET | uin             | 获取指定机器人登录二维码                   |
-| /add    | POST | {uin,...config} | 添加机器人 config 为机器人配置            |
-| /edit   | POST | {uin,...config} | 修改机器人配置 config 为机器人配置          |
-| /remove | get | uin,force       | 移除机器人,force为true时，将删除机器人data目录 |
-
-# 鸣谢
-1. [takayama-lily/oicq](https://github.com/takayama-lily/oicq) 底层服务支持
-2. [takayama-lily/onebot](https://github.com/takayama-lily/node-onebot) oneBots原先版本
+<div align="center">
+    <h1>基于oicq的oneBot实现</h1>
+    <p>
+
+[![dm](https://shields.io/npm/dm/onebots)](https://www.npmjs.com/package/onebots)
+[![oneBot V11](https://img.shields.io/badge/OneBot-11-black?logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAHAAAABwCAMAAADxPgR5AAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAAAxQTFRF////29vbr6+vAAAAk1hCcwAAAAR0Uk5T////AEAqqfQAAAKcSURBVHja7NrbctswDATQXfD//zlpO7FlmwAWIOnOtNaTM5JwDMa8E+PNFz7g3waJ24fviyDPgfhz8fHP39cBcBL9KoJbQUxjA2iYqHL3FAnvzhL4GtVNUcoSZe6eSHizBcK5LL7dBr2AUZlev1ARRHCljzRALIEog6H3U6bCIyqIZdAT0eBuJYaGiJaHSjmkYIZd+qSGWAQnIaz2OArVnX6vrItQvbhZJtVGB5qX9wKqCMkb9W7aexfCO/rwQRBzsDIsYx4AOz0nhAtWu7bqkEQBO0Pr+Ftjt5fFCUEbm0Sbgdu8WSgJ5NgH2iu46R/o1UcBXJsFusWF/QUaz3RwJMEgngfaGGdSxJkE/Yg4lOBryBiMwvAhZrVMUUvwqU7F05b5WLaUIN4M4hRocQQRnEedgsn7TZB3UCpRrIJwQfqvGwsg18EnI2uSVNC8t+0QmMXogvbPg/xk+Mnw/6kW/rraUlvqgmFreAA09xW5t0AFlHrQZ3CsgvZm0FbHNKyBmheBKIF2cCA8A600aHPmFtRB1XvMsJAiza7LpPog0UJwccKdzw8rdf8MyN2ePYF896LC5hTzdZqxb6VNXInaupARLDNBWgI8spq4T0Qb5H4vWfPmHo8OyB1ito+AysNNz0oglj1U955sjUN9d41LnrX2D/u7eRwxyOaOpfyevCWbTgDEoilsOnu7zsKhjRCsnD/QzhdkYLBLXjiK4f3UWmcx2M7PO21CKVTH84638NTplt6JIQH0ZwCNuiWAfvuLhdrcOYPVO9eW3A67l7hZtgaY9GZo9AFc6cryjoeFBIWeU+npnk/nLE0OxCHL1eQsc1IciehjpJv5mqCsjeopaH6r15/MrxNnVhu7tmcslay2gO2Z1QfcfX0JMACG41/u0RrI9QAAAABJRU5ErkJggg==)](https://onebot.dev/)
+[![oneBot V12](https://img.shields.io/badge/OneBot-12-black?logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAHAAAABwCAMAAADxPgR5AAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAAAxQTFRF////29vbr6+vAAAAk1hCcwAAAAR0Uk5T////AEAqqfQAAAKcSURBVHja7NrbctswDATQXfD//zlpO7FlmwAWIOnOtNaTM5JwDMa8E+PNFz7g3waJ24fviyDPgfhz8fHP39cBcBL9KoJbQUxjA2iYqHL3FAnvzhL4GtVNUcoSZe6eSHizBcK5LL7dBr2AUZlev1ARRHCljzRALIEog6H3U6bCIyqIZdAT0eBuJYaGiJaHSjmkYIZd+qSGWAQnIaz2OArVnX6vrItQvbhZJtVGB5qX9wKqCMkb9W7aexfCO/rwQRBzsDIsYx4AOz0nhAtWu7bqkEQBO0Pr+Ftjt5fFCUEbm0Sbgdu8WSgJ5NgH2iu46R/o1UcBXJsFusWF/QUaz3RwJMEgngfaGGdSxJkE/Yg4lOBryBiMwvAhZrVMUUvwqU7F05b5WLaUIN4M4hRocQQRnEedgsn7TZB3UCpRrIJwQfqvGwsg18EnI2uSVNC8t+0QmMXogvbPg/xk+Mnw/6kW/rraUlvqgmFreAA09xW5t0AFlHrQZ3CsgvZm0FbHNKyBmheBKIF2cCA8A600aHPmFtRB1XvMsJAiza7LpPog0UJwccKdzw8rdf8MyN2ePYF896LC5hTzdZqxb6VNXInaupARLDNBWgI8spq4T0Qb5H4vWfPmHo8OyB1ito+AysNNz0oglj1U955sjUN9d41LnrX2D/u7eRwxyOaOpfyevCWbTgDEoilsOnu7zsKhjRCsnD/QzhdkYLBLXjiK4f3UWmcx2M7PO21CKVTH84638NTplt6JIQH0ZwCNuiWAfvuLhdrcOYPVO9eW3A67l7hZtgaY9GZo9AFc6cryjoeFBIWeU+npnk/nLE0OxCHL1eQsc1IciehjpJv5mqCsjeopaH6r15/MrxNnVhu7tmcslay2gO2Z1QfcfX0JMACG41/u0RrI9QAAAABJRU5ErkJggg==)](https://12.onebot.dev/)
+[![node engine](https://img.shields.io/node/v/oitq?color=339933&style=flat-square&labelColor=FAFAFA&logo=Node.js)](https://nodejs.org)
+[![qq group](https://img.shields.io/badge/group-860669870-blue?style=flat-square&labelColor=FAFAFA&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAD4AAAA+CAMAAABEH1h2AAACB1BMVEX///8AAADoHx/6rgjnFhb/tQj9/f3/sggEAgLyICD//vztICAGBgbrHx8MDAwJCQn7rwj09PTi4uKbm5uBgYHvICAREREODg79sQgkJCT39/f/+/HExMT3q6tNTU37vTRFMQI4JwIgFgHt7e3r6+vd3d3b29u7u7uwsLDyenp4eHjxc3NZWVn//fj//PTf399vb29UVFQ8PDwuLi76uCUgICDfHh7oGhoYGBgVFRWjcgf6+vrR0dG2traYmJiUlJRqampiYmJXV1dDQ0M2Njbk5OTX19fKysr+5a70lJTyfX1zc3P90Gz+yFBGRkbsRET+vCn6tyLUHBwcHBzDGhqxFxesFxeeFRV4EBD/twjGiwa0fwaodgUbAwMJBgD++PjT09O/v7+xsbGpqamoqKj4p6eJiYloaGgxMTEnJyfv7+/96Ojm5ubq5eX84ODP1NTOzs7Nzc3/wcH4vb34urqioqKKioqCfXTvZWWeY2OMfmCgh1G8l0TdqjrqKirZHR3mHBy3GBiXFBSSExN/EREmERHmDg76sAxVCwtICgr/vQlECQnupwjupgjrpQg4CAjUlAfQkgfMjwbAhga7gwYiBQWJYASAWgR3UwRrSwNiRQMUAgISAgISDQEUDgD/9+X+9uX60dH3sbH94aP94aK/kZG+kJCMjIzzhobwbm7uXl7uWlrpLCyLIqc8AAAEYklEQVRIx62Wd1vaUBTGcxACmIBYRpG2LEFoRcVi0SJaLLV1a927rXV277333nvv/SF7b3JNi+Qm2KfvPyT35Pck57znXg6jKNblYpl/00brTDpWVBRLz1g3LpatnUwXgKSC9GTtYujlq2GBVi/PnT5SAFkqOJIjzEZBVtHcqrgKKFqVC30YqDqsTpesBUHmlC0mXsVsKbN4tbZEFV9PKlXHMMWrhZoXM0wdqeV6VcsMIKgB32ziAfhN+KpBXDWo2VcJotDLt9axGwA2CPWuI8uVKpmTr+Q3MsVFMJFCn8HWuyPbSniSk3L20yDhSeRUK0Dr1/S6mekgwWFasWOkZg0xO+YgjOroLsHtHpKaV6l3lpiBKIUSCQVqAGp24EAKiMxLFPAwzGvppvn+W4UtWCoFwgq4DST1WLdFDYJZ0W3WHpBkU7SNLnXrkM9EBr/3+ZPEyKOHDx+NJJ489/pJNwl9QFPhGhDkfzp8S69D0iMJv7eGn/rF2JpCKh4Qt8v4gxt6S16GLPobD8bFbROg+0YK7Bux6DJ4dDviI5bQnauQbPeO3tHpnBYBdep0d0a9kvEVKl1D8n+RuHc7z+nMu30v8QLnrd43uy9neDTu93m9Pv94xuLl3VT8ULx/8OaYASgyjN0c7I8fouLHjHYjF+8dGLx29/Erw1/cq8d3rw0O9MY59MAxGr3njEmj0Zg4u9Fuinf3nu8fuHDx4oWB/vO93XETWuSE8Jk9FLzZqPkjE8fZ7UYku53DnCRjszy9pZPT5CCuc4ssfsBoygU3GQ/I4sf7znJGzqSIogfO9h2Xo3c5YOz6pb7uc9pqObJaq9We6+67dH0MHLtkcCsIevll6ke1RBBVa351/myZ+vwSBFll8A4QtZf5oBXpzpZSpJXfmqcOvt+J67WX9EJHNh00SztqhYhrW2g70hzMwutBVE2xhK9c+ExxDXmoPgt3g3SaSDjtNAK37EGDVeSi464iAPkjJwSLwSFEOeFz+3iwyaZOSndFi3WllFK67ORdc3hb94jG7VzR3FL6vXTlQVnjerD5c66MQCMOVOIMDPsZqvZj0laJX9KYEUiigKNiOyBN0nEhvr3CgV6SzBxphE5O4iGglY63ojCfFHbH8oV4A8vU4lFsllX8C4zVMmzDQjwIHYXEPn4fDd/HE8sKOyCz69kJTDM4LYjS8CjgAjGYn2Cp86wjKE8HHapzbQC3ZUQ+FsEtHWAUFeIFDyinER9iVLQOD39hmakJD4zr6JzE84ivzzpNEM2r0+VN7YnXeHbe+vfqVjxnv060N5UrwvkfPWiWue/F51kk3MgKnjaGI2Y8MdxHM47nU74C3abTo3lCnzfqA+zgrDsScc86hHllNE8I6dro/LurQ3q902lxDlmGn/neANEb37NhyxBadur1Q1ff0t/e1Nbu8VRVbd5c1dXlOX3q5ImjR0+cPHXa09WF16o8nva2pnzl9MvKlyGVl5Xl5wtPop+y+TWC/jf9BuxZscgeRqlfAAAAAElFTkSuQmCC&logoColor=000000)](https://jq.qq.com/?_wv=1027&k=B22VGXov)
+
+[![Star History Chart](https://api.star-history.com/svg?repos=lc-cn/onebots&type=Date)](https://star-history.com/#lc-cn/onebots&Date)
+
+
+[Type Docs](https://lc-cn.github.io/onebots) 
+
+
+</p>
+</div>
+
+# 使用示例
+## 全局安装
+### 1 安装依赖
+```shell
+npm install -g onebots
+```
+### 2 初始化配置文件
+(1) 配置文件存到(用户目录/.onebots/config.yaml)
+```shell
+onebots
+```
+(2) 配置文件存到(当前目录/config.yaml)
+```shell
+onebots -c config.yaml
+```
+二选一即可
+### 3 更改配置文件后，启动项目
+
+(1) 使用全局配置文件(用户目录/.onebots/config.yaml)
+```shell
+onebots
+```
+(2) 使用指定配置文件(当前目录/config.yaml)
+```shell
+onebots -c config.yaml
+```
+# 2 在NodeJS项目中启动
+## 1 初始化node项目
+```shell
+npm init -y
+```
+## 2. 安装onebots
+```shell
+npm install onebots
+```
+## 3. 在项目跟目录添加配置文件config.yaml
+```yaml
+port: 6727 # 项目onebots监听的端口(默认：6727)
+1472258369: # 你的机器人账户
+  version: V11 # oneBot版本（V11 或 V12）
+```
+## 4. 新建入口文件`index.js`并输入一下内容
+```javascript
+const {createApp}=require('onebots')
+createApp('config.yaml')
+.start()
+```
+## 5. 启动项目
+```shell
+node ./index.js
+```
+# 使用接口管理oneBot
+
+| url     | method | params          | desc                           |
+|:--------| :--- |:----------------|:-------------------------------|
+| /list   | GET |                 | 获取当前运行的机器人列表                   |
+| /detail | GET | uin             | 获取指定机器人配置                      |
+| /qrcode | GET | uin             | 获取指定机器人登录二维码                   |
+| /add    | POST | {uin,...config} | 添加机器人 config 为机器人配置            |
+| /edit   | POST | {uin,...config} | 修改机器人配置 config 为机器人配置          |
+| /remove | get | uin,force       | 移除机器人,force为true时，将删除机器人data目录 |
+
+# 鸣谢
+1. [takayama-lily/oicq](https://github.com/takayama-lily/oicq) 底层服务支持
+2. [takayama-lily/onebot](https://github.com/takayama-lily/node-onebot) oneBots原先版本

package/lib/bin.d.ts

@@ -1,2 +1,2 @@
-#!/usr/bin/env node
-export {};
+#!/usr/bin/env node
+export {};

package/lib/bin.js

@@ -1,5 +1,11 @@
-#!/usr/bin/env node
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const app_1 = require("./server/app");
-(0, app_1.createApp)().start();
+#!/usr/bin/env node
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const app_1 = require("./server/app");
+const execArgv = process.argv.splice(2);
+const obj = {};
+for (let i = 0; i < execArgv.length; i += 2) {
+    obj[execArgv[i]] = execArgv[i + 1];
+}
+console.log(obj);
+(0, app_1.createApp)(obj['-c']).start();

package/lib/config.sample.yaml

@@ -0,0 +1,31 @@
+port: 6727 # 监听端口
+general: # 通用配置，在单个配置省略时的默认值
+  V11: # oneBotV11的通用配置
+    heartbeat: 3 # 心跳间隔 (秒)
+    access_token: '' # 访问api的token
+    post_timeout: 15 # 上报超时时间，(秒)
+    secret: '' # 上报数据的sha1签名密钥
+    rate_limit_interval: 4 # ws心跳间隔(秒)
+    post_message_format: string # "string"或"array"
+    reconnect_interval: 3 # 重连间隔 (秒)
+    use_http: true # 是否使用 http
+    enable_cors: true # 是否允许跨域
+    use_ws: true # 是否使用websocket
+    http_reverse: [] # http上报地址
+    ws_reverse: [] # 反向ws连接地址
+  V12: # oneBotV12的通用配置
+    heartbeat: 3 # 心跳间隔 (秒)
+    access_token: '' # 访问api的token
+    request_timeout: 15 # 上报超时时间 (秒)
+    reconnect_interval: 3 # 重连间隔 (秒)
+    enable_cors: true # 是否允许跨域
+    use_http: true # 是否启用http
+    use_ws: true # 是否启用 websocket
+    webhook: [] # http 上报地址
+    ws_reverse: [] # 反向ws连接地址
+log_level: info # 日志等级
+# 每个账号的单独配置(用于覆盖通用配置)
+123456789:
+  version: V11 # 使用的oneBot版本
+  password: abcedfghi # 账号密码，未配置则扫码登陆
+  # 。。。其他配置项参见上方对应oneBot版本的通用配置

package/lib/db.d.ts

@@ -1,19 +1,19 @@
-/// <reference types="node" />
-import { EventEmitter } from "events";
-export declare class Db extends EventEmitter {
-    private readonly path;
-    private data;
-    private raw_data;
-    constructor(path: string, force_create?: boolean);
-    get(key: string, escape?: boolean): any;
-    set(key: string, value: any, escape?: boolean): any;
-    has(key: string, escape?: boolean): boolean;
-    delete(key: string, escape?: boolean): boolean;
-    write(): Promise<void>;
-}
-export declare namespace Db {
-    interface Config {
-        path: string;
-        force?: boolean;
-    }
-}
+/// <reference types="node" />
+import { EventEmitter } from "events";
+export declare class Db extends EventEmitter {
+    private readonly path;
+    private data;
+    private raw_data;
+    constructor(path: string, force_create?: boolean);
+    get(key: string, escape?: boolean): any;
+    set(key: string, value: any, escape?: boolean): any;
+    has(key: string, escape?: boolean): boolean;
+    delete(key: string, escape?: boolean): boolean;
+    write(): Promise<void>;
+}
+export declare namespace Db {
+    interface Config {
+        path: string;
+        force?: boolean;
+    }
+}

package/lib/db.js

@@ -1,91 +1,91 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Db = void 0;
-const fs_1 = require("fs");
-const promises_1 = require("fs/promises");
-const events_1 = require("events");
-class Db extends events_1.EventEmitter {
-    constructor(path, force_create = true) {
-        super();
-        this.path = path;
-        this.data = {};
-        this.raw_data = '{}';
-        if (!this.path.toLowerCase().endsWith('.json'))
-            this.path = this.path + '.json';
-        if (!(0, fs_1.existsSync)(this.path) && force_create) {
-            (0, fs_1.writeFileSync)(this.path, this.raw_data);
-        }
-        try {
-            const raw_data = (0, fs_1.readFileSync)(this.path, 'utf8');
-            this.raw_data = raw_data || this.raw_data;
-            this.data = JSON.parse(this.raw_data);
-        }
-        catch (error) {
-            const { message } = error;
-            if (!message.includes('ENOENT: no such file or directory')) {
-                throw error;
-            }
-        }
-    }
-    get(key, escape = true) {
-        const func = new Function(`return this.data.${key}`);
-        const _this = this;
-        let result;
-        try {
-            result = escape ? func.apply(this) : this.data[key];
-        }
-        catch {
-            throw new Error('不可达的位置:' + key.toString());
-        }
-        return result && typeof result === 'object' ? new Proxy(result, {
-            get(target, p) {
-                return target[p];
-            },
-            set(target, p, value, receiver) {
-                const result = target[p] = value;
-                _this.write();
-                return result;
-            }
-        }) : result;
-    }
-    set(key, value, escape = true) {
-        const func = new Function('value', `return this.data.${key}=value`);
-        const _this = this;
-        let result;
-        result = escape ? func.apply(this, [value]) : this.data[key] = value;
-        this.raw_data = JSON.stringify(this.data, null, 2);
-        this.write();
-        return result && typeof result === 'object' ? new Proxy(result, {
-            get(target, p) {
-                return target[p];
-            },
-            set(target, p, value, receiver) {
-                const result = target[p] = value;
-                _this.write();
-                return result;
-            }
-        }) : result;
-    }
-    has(key, escape = true) {
-        return escape ? new Function(`return !!this.data.${key}`).apply(this) : !!this.data[key];
-    }
-    delete(key, escape = true) {
-        const result = escape ? new Function(`return delete this.data.${key}`).apply(this) : delete this.data[key];
-        this.write();
-        return result;
-    }
-    async write() {
-        try {
-            const raw_data = JSON.stringify(this.data, null, 2);
-            if (raw_data !== this.raw_data) {
-                await (0, promises_1.writeFile)(this.path, raw_data);
-                this.raw_data = raw_data;
-            }
-        }
-        catch (error) {
-            this.data = JSON.parse(this.raw_data);
-            throw error;
-        }
-    }
-}
-exports.Db = Db;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Db = void 0;
+const fs_1 = require("fs");
+const promises_1 = require("fs/promises");
+const events_1 = require("events");
+class Db extends events_1.EventEmitter {
+    constructor(path, force_create = true) {
+        super();
+        this.path = path;
+        this.data = {};
+        this.raw_data = '{}';
+        if (!this.path.toLowerCase().endsWith('.json'))
+            this.path = this.path + '.json';
+        if (!(0, fs_1.existsSync)(this.path) && force_create) {
+            (0, fs_1.writeFileSync)(this.path, this.raw_data);
+        }
+        try {
+            const raw_data = (0, fs_1.readFileSync)(this.path, 'utf8');
+            this.raw_data = raw_data || this.raw_data;
+            this.data = JSON.parse(this.raw_data);
+        }
+        catch (error) {
+            const { message } = error;
+            if (!message.includes('ENOENT: no such file or directory')) {
+                throw error;
+            }
+        }
+    }
+    get(key, escape = true) {
+        const func = new Function(`return this.data.${key}`);
+        const _this = this;
+        let result;
+        try {
+            result = escape ? func.apply(this) : this.data[key];
+        }
+        catch {
+            throw new Error('不可达的位置:' + key.toString());
+        }
+        return result && typeof result === 'object' ? new Proxy(result, {
+            get(target, p) {
+                return target[p];
+            },
+            set(target, p, value, receiver) {
+                const result = target[p] = value;
+                _this.write();
+                return result;
+            }
+        }) : result;
+    }
+    set(key, value, escape = true) {
+        const func = new Function('value', `return this.data.${key}=value`);
+        const _this = this;
+        let result;
+        result = escape ? func.apply(this, [value]) : this.data[key] = value;
+        this.raw_data = JSON.stringify(this.data, null, 2);
+        this.write();
+        return result && typeof result === 'object' ? new Proxy(result, {
+            get(target, p) {
+                return target[p];
+            },
+            set(target, p, value, receiver) {
+                const result = target[p] = value;
+                _this.write();
+                return result;
+            }
+        }) : result;
+    }
+    has(key, escape = true) {
+        return escape ? new Function(`return !!this.data.${key}`).apply(this) : !!this.data[key];
+    }
+    delete(key, escape = true) {
+        const result = escape ? new Function(`return delete this.data.${key}`).apply(this) : delete this.data[key];
+        this.write();
+        return result;
+    }
+    async write() {
+        try {
+            const raw_data = JSON.stringify(this.data, null, 2);
+            if (raw_data !== this.raw_data) {
+                await (0, promises_1.writeFile)(this.path, raw_data);
+                this.raw_data = raw_data;
+            }
+        }
+        catch (error) {
+            this.data = JSON.parse(this.raw_data);
+            throw error;
+        }
+    }
+}
+exports.Db = Db;

package/lib/index.d.ts

@@ -1,5 +1,5 @@
-export * from './server/app';
-export * from './server/router';
-export * from './onebot';
-export * from './types';
-export * from './utils';
+export * from './server/app';
+export * from './server/router';
+export * from './onebot';
+export * from './types';
+export * from './utils';

package/lib/index.js

@@ -1,21 +1,21 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./server/app"), exports);
-__exportStar(require("./server/router"), exports);
-__exportStar(require("./onebot"), exports);
-__exportStar(require("./types"), exports);
-__exportStar(require("./utils"), exports);
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./server/app"), exports);
+__exportStar(require("./server/router"), exports);
+__exportStar(require("./onebot"), exports);
+__exportStar(require("./types"), exports);
+__exportStar(require("./utils"), exports);

package/lib/onebot.d.ts

@@ -1,44 +1,44 @@
-/// <reference types="node" />
-import 'oicq2-cq-enable';
-import { EventEmitter } from 'events';
-import { App } from "./server/app";
-import { Client } from "oicq";
-import { V11 } from "./service/V11";
-import { V12 } from "./service/V12";
-import { MayBeArray } from "./types";
-export declare class NotFoundError extends Error {
-    message: string;
-}
-export declare class OneBot<V extends OneBot.Version> extends EventEmitter {
-    app: App;
-    readonly uin: number;
-    config: OneBotConfig[];
-    status: OneBotStatus;
-    protected password: string;
-    client: Client;
-    instances: (V11 | V12)[];
-    constructor(app: App, uin: number, config: MayBeArray<OneBotConfig>);
-    start(): Promise<void>;
-    startListen(): void;
-    stop(force?: boolean): Promise<void>;
-    dispatch(data: any): void;
-}
-export declare enum OneBotStatus {
-    Good = 0,
-    Bad = 1
-}
-export type OneBotConfig = OneBot.Config<OneBot.Version>;
-export declare namespace OneBot {
-    type Version = 'V11' | 'V12';
-    type Config<V extends Version = 'V11'> = ({
-        version?: V;
-        password?: string;
-    } & (V extends 'V11' ? V11.Config : V12.Config));
-    interface Base {
-        start(path?: string): any;
-        stop(): any;
-        dispatch(...args: any[]): any;
-        apply(...args: any[]): any;
-    }
-}
-export declare const BOOLS: string[];
+/// <reference types="node" />
+import 'oicq2-cq-enable';
+import { EventEmitter } from 'events';
+import { App } from "./server/app";
+import { Client } from "oicq";
+import { V11 } from "./service/V11";
+import { V12 } from "./service/V12";
+import { MayBeArray } from "./types";
+export declare class NotFoundError extends Error {
+    message: string;
+}
+export declare class OneBot<V extends OneBot.Version> extends EventEmitter {
+    app: App;
+    readonly uin: number;
+    config: OneBotConfig[];
+    status: OneBotStatus;
+    protected password: string;
+    client: Client;
+    instances: (V11 | V12)[];
+    constructor(app: App, uin: number, config: MayBeArray<OneBotConfig>);
+    start(): Promise<void>;
+    startListen(): void;
+    stop(force?: boolean): Promise<void>;
+    dispatch(data: any): void;
+}
+export declare enum OneBotStatus {
+    Good = 0,
+    Bad = 1
+}
+export declare type OneBotConfig = OneBot.Config<OneBot.Version>;
+export declare namespace OneBot {
+    type Version = 'V11' | 'V12';
+    type Config<V extends Version = 'V11'> = ({
+        version?: V;
+        password?: string;
+    } & (V extends 'V11' ? V11.Config : V12.Config));
+    interface Base {
+        start(path?: string): any;
+        stop(): any;
+        dispatch(...args: any[]): any;
+        apply(...args: any[]): any;
+    }
+}
+export declare const BOOLS: string[];