node-karin 0.12.0 → 0.12.2-5.pr.206.07c7722

package/README.md

@@ -1,55 +1,28 @@
-![karin](https://socialify.git.ci/karinjs/karin/image?description=1&font=Bitter&forks=1&issues=1&language=1&logo=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F162426977%3Fs%3D400%26u%3D8ae82fa0321857b24c7ed33a3d0d0d51323d3cfc%26v%3D4&name=1&owner=1&pattern=Plus&pulls=1&stargazers=1&theme=Light)
+![karin](https://socialify.git.ci/karinjs/karin/image?description=1&font=Bitter&forks=1&issues=1&language=1&logo=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F162426977%3Fs%3D200%26v%3D4&name=1&owner=1&pulls=1&stargazers=1&theme=Auto)
 
-[![neostandard javascript style](https://img.shields.io/badge/code_style-neostandard-brightgreen?style=flat)](https://github.com/neostandard/neostandard)
+## 快速开始
 
-[文档](https://karinjs.github.io/Karin/)  
-[文档`(瑜笙提供)`](https://karin.fun)
+[点击跳转文档](https://karin.fun/)
 
-基于 [Kritor](https://github.com/KarinJS/kritor-kotlin) 标准进行开发的 [nodejs](https://nodejs.org/en) 机器人框架  
+### 开发
 
-> 本项目正在开发中，现阶段我并不能为你解决任何问题，谨慎使用。  
-> 此项目不想成为、代替任何项目，也没有这个能力，请别造谣。  
-> ~~不欢迎某些人，勿扰谢谢(ps: )~~  
+tsx 开发步骤
 
----
+```bash
+build:dev && pnpm app
+build:dev && pnpm app:w
+build:dev && pnpm app:w --debug
+```
 
-### 目前计划
+正式发版
 
-- [x] [kritor标准](https://github.com/KarinJS/kritor) **暂时去除**
-- [x] [onebot11](https://github.com/botuniverse/onebot-11)
-- [ ] [onebot12](https://onebot.dev/)
-- [ ] 支持主动[grpc](https://grpc.io/)
-- [x] 支持被动[grpc](https://grpc.io/) **暂时去除**
-- [x] 支持主动ws 12暂未支持
-- [x] 支持被动ws
-- [ ] 支持onebot HTTP
-- [x] 支持[onebots](https://github.com/lc-cn/onebots)
-- [x] 外置[puppeteer](https://github.com/KarinJS/karin-plugin-puppeteer)
-- [x] 降低对`redis`的依赖，开始逐渐抛弃redis
-- [x] 支持 package.karin
-- [x] 支持`redis`集群
-
-### 感谢
-
-Karin的开发离不开以下项目的帮助：
-
-- [icqqjs](https://github.com/icqqjs)
-- [Kritor](https://github.com/KarinJS/kritor) Kritor标准
-- [OpenShamrock](https://github.com/whitechi73/OpenShamrock) Kritor标准Kotlin的实现
-- [onebots](https://github.com/lc-cn/onebots) onebots适配器
-- [onebot-11](https://github.com/botuniverse/onebot-11) onebot11标准
-- [Miao-Yunzai](https://github.com/yoimiya-kokomi/Miao-Yunzai) 最开始的代码结构
-- [Yunzai-Bot](https://gitee.com/le-niao/Yunzai-Bot) 最开始的代码结构
-
-### 来加入我们吧~
-
-QQGroup: 967068507
-
-Discord: [☘Karin的喵趴～](https://discord.com/channels/1251552521957408878/1251552521957408881)
+```bash
+pnpm build
+```
 
 ### 贡献者
 
-> 🌟星光闪烁，你们的智慧如同璀璨的夜空。感谢所有为**Karin**做出贡献的人！
+> 🌟 星光闪烁，你们的智慧如同璀璨的夜空。感谢所有为**Karin**做出贡献的人！
 
 [![贡献者](https://contributors-img.web.app/image?repo=KarinJS/Karin)](https://github.com/KarinJS/Karin/graphs/contributors)
 

package/default/comment/config.json

@@ -0,0 +1,34 @@
+{
+  "log4jsCfg": "log4js 日志配置",
+  "log4jsCfg.level": "日志等级: trace, debug, info, warn, fatal, mark, error, off",
+  "log4jsCfg.daysToKeep": "日志保留天数",
+  "log4jsCfg.overall": "整体化: 将日志输出到一个文件(一天为一个文件)。日志较多的情况下不建议与碎片化同时开启",
+  "log4jsCfg.fragments": "碎片化: 将日志分片，达到指定大小后自动切割。日志较多的情况下不建议与整体化同时开启",
+  "log4jsCfg.maxLogSize": "日志文件最大大小 (MB)",
+  "log4jsCfg.logColor": "logger.fnc颜色。不支持热更新",
+  "pm2Restart": "重启是否调用pm2。如果不调用则会直接关机。此配置适合有进程守护的程序",
+  "private.enable": "是否启用私聊",
+  "private.tips": "关闭私聊后回复的提示词。为空则不回复",
+  "private.disable": "关闭私聊后的用户白名单",
+  "ffmpegPath": "ffmpeg路径，用于音视频处理",
+  "ffprobePath": "ffprobe路径，用于音视频处理",
+  "ffplayPath": "ffplay路径，用于音视频处理",
+  "master": "Bot主人列表 (主权限)",
+  "admin": "Bot管理列表 (子权限)",
+  "disable.users": "黑名单用户",
+  "disable.groups": "黑名单群聊",
+  "disable.guilds": "黑名单频道",
+  "disable.channels": "黑名单子频道",
+  "disable.directs": "黑名单频道私聊: 禁用指定来源频道的私聊",
+  "disable.groupLog": "消息日志黑名单群聊: 设置后不会打印指定群的消息日志",
+  "disable.guildLog": "消息日志黑名单频道: 设置后不会打印指定频道的消息日志",
+  "disable.channelLog": "消息日志黑名单子频道: 设置后不会打印指定子频道的消息日志",
+  "enable.users": "白名单用户",
+  "enable.groups": "白名单群聊",
+  "enable.guilds": "白名单频道",
+  "enable.channels": "白名单子频道",
+  "enable.directs": "白名单频道私聊: 仅允许指定来源频道的私聊",
+  "enable.groupLog": "消息日志白名单群聊: 设置后只会打印指定群的消息日志",
+  "enable.guildLog": "消息日志白名单频道: 设置后只会打印指定频道的消息日志",
+  "enable.channelLog": "消息日志白名单子频道: 设置后只会打印指定子频道的消息日志"
+}

package/default/comment/friendDirect.json

@@ -0,0 +1,10 @@
+{
+  "default": "全局默认配置",
+  "default.cd": "好友消息冷却时间，单位秒，0则无限制",
+  "default.mode": "机器人响应模式: 0-所有, 2-仅回应管理员, 3-仅回应别名, 5-管理员无限制, 非管理员别名, 6-仅回应主人",
+  "default.alias": "机器人别名: 设置后别名+指令触发机器人",
+  "default.enable": "白名单插件、功能: 只有在白名单中的插件、功能才会响应",
+  "default.disable": "黑名单插件、功能: 黑名单中的插件、功能不会响应",
+  "Bot:selfId": "单个Bot默认配置",
+  "Bot:selfId:userId": "单个Bot:单个好友、频道成员 配置"
+}

package/default/comment/groupGuild.json

@@ -0,0 +1,11 @@
+{
+  "default": "全局默认配置",
+  "default.cd": "好友消息冷却时间，单位秒，0则无限制",
+  "default.mode": "机器人响应模式: 0-所有, 2-仅回应管理员, 3-仅回应别名, 5-管理员无限制，非管理员别名, 6-仅回应主人",
+  "default.alias": "机器人别名: 设置后别名+指令触发机器人",
+  "default.alias.k": "别名: k",
+  "default.enable": "白名单插件、功能: 只有在白名单中的插件、功能才会响应，例如 karin-plugin-test:app.js",
+  "default.disable": "黑名单插件、功能: 黑名单中的插件、功能不会响应，例如 karin-plugin-test:app.js",
+  "Bot:selfId": "单个Bot默认配置",
+  "Bot:selfId:userId": "单个Bot:单个好友、频道成员配置"
+}

package/default/comment/server.json

@@ -0,0 +1,17 @@
+{
+  "hmrToServer": "当前文件热更新是否重启http服务",
+  "host": "http监听地址",
+  "port": "http端口",
+  "timeout": "ws api请求超时时间，单位：秒",
+  "onebotHttp": "OneBot HTTP 配置列表",
+  "reverseWsToken": "反向WebSocket鉴权秘钥",
+  "forwardWs": "OneBot11正向WebSocket地址列表",
+  "renderWs": "WebSocket 渲染器地址 (例如 ws://127.0.0.1:7005/ws/render)",
+  "renderHttp": "HTTP 渲染器地址列表",
+  "rootMsg": "HTTP根路由随机返回的文案",
+  "console": "console控制台适配器",
+  "console.isLocal": "只允许本地访问",
+  "console.port": "console控制台端口",
+  "console.token": "如果 isLocal 为 false 则需要配置 token",
+  "console.host": "自定义host"
+}

package/default/config/config.yaml

@@ -0,0 +1,78 @@
+# 详细配置请参考: https://karin.fun/start/file
+
+# log4js 日志配置
+log4jsCfg:
+  # 日志等级: trace, debug, info, warn, fatal, mark, error, off
+  level: info
+  # 日志保留天数
+  daysToKeep: 7
+  # 整体化: 将日志输出到一个文件(一天为一个文件) 日志较多的情况下不建议与碎片化同时开启
+  overall: true
+  # 碎片化: 将日志分片，达到指定大小后自动切割 日志较多的情况下不建议与整体化同时开启
+  fragments: false
+  # 日志文件最大大小 MB
+  maxLogSize: 30
+  # logger.fnc颜色 不支持热更新
+  logColor: "#E1D919"
+
+# 重启是否调用pm2 如果不调用则会直接关机 此配置适合有进程守护的程序
+pm2Restart: true
+
+# 私聊设置 频道和好友共享此配置
+private:
+  # 是否启用私聊
+  enable: true
+  # 关闭私聊后回复的提示词 为空则不回复
+  tips: ""
+  # 关闭私聊后的用户白名单
+  disable: []
+
+# ffmpeg配置 用于音视频处理
+ffmpegPath:
+ffprobePath:
+ffplayPath:
+
+# Bot主人列表 主权限
+master:
+  - console
+
+# Bot管理列表 子权限
+admin: []
+
+# 黑名单相关
+disable:
+  # 黑名单用户
+  users: []
+  # 黑名单群聊
+  groups: []
+  # 黑名单频道
+  guilds: []
+  # 黑名单子频道
+  channels: []
+  # 黑名单频道私聊 禁用指定来源频道的私聊
+  directs: []
+  # 消息日志黑名单群聊 设置后不会打印指定群的消息日志
+  groupLog: []
+  # 消息日志黑名单频道 设置后不会打印指定频道的消息日志
+  guildLog: []
+  # 消息日志黑名单子频道 设置后不会打印指定子频道的消息日志
+  channelLog: []
+
+# 白名单相关
+enable:
+  # 白名单用户
+  users: []
+  # 白名单群聊
+  groups: []
+  # 白名单频道
+  guilds: []
+  # 白名单子频道
+  channels: []
+  # 白名单频道私聊 仅允许指定来源频道的私聊
+  directs: []
+  # 消息日志白名单群聊 设置后只会打印指定群的消息日志
+  groupLog: []
+  # 消息日志白名单频道 设置后只会打印指定频道的消息日志
+  guildLog: []
+  # 消息日志白名单子频道 设置后只会打印指定子频道的消息日志
+  channelLog: []

package/default/config/friendDirect.yaml

@@ -0,0 +1,31 @@
+# 详细配置请参考: https://karin.fun/start/file
+
+# 全局默认配置
+default:
+  # 好友消息冷却时间，单位秒,0则无限制
+  cd: 0
+  # 机器人响应模式(私聊没有群聊那么多模式)，0-所有 2-仅回应管理员 3-仅回应别名 5-管理员无限制，非管理员别名 6-仅回应主人
+  mode: 0
+  # 机器人别名 设置后别名+指令触发机器人
+  alias:
+    - k
+  # 白名单插件、功能，只有在白名单中的插件、功能才会响应 `karin-plugin-test:app.js` `karin-plugin-test:测试转发`
+  enable: []
+  # 黑名单插件、功能，黑名单中的插件、功能不会响应 `karin-plugin-test:app.js` `karin-plugin-test:测试转发`
+  disable: []
+
+# 单个Bot默认配置
+Bot:selfId:
+  cd: 0
+  mode: 0
+  alias: []
+  enable: []
+  disable: []
+
+# 单个Bot:单个好友、频道成员 配置
+Bot:selfId:userId:
+  cd: 0
+  mode: 0
+  alias: []
+  enable: []
+  disable: []

package/default/config/groupGuild.yaml

@@ -0,0 +1,70 @@
+# 详细配置请参考: https://karin.fun/start/file
+
+# 全局默认配置
+default:
+  # 群聊、频道中所有消息冷却时间，单位秒，0则无限制
+  cd: 0
+  # 群聊、频道中 每个人的消息冷却时间，单位秒，0则无限制。注意，开启后所有消息都会进CD，无论是否触发插件。
+  userCD: 1
+  # 机器人响应模式，0-所有 1-仅@机器人 2-仅回应管理员 3-仅回应别名 4-别名或@机器人 5-管理员无限制，成员别名或@机器人 6-仅回应主人
+  mode: 0
+
+  # 机器人别名 设置后别名+指令触发机器人
+  alias:
+    - k
+
+  # 白名单插件、功能，只有在白名单中的插件、功能才会响应 `karin-plugin-test:app.js` `karin-plugin-test:测试转发`
+  enable: []
+
+  # 黑名单插件、功能，黑名单中的插件、功能不会响应 `karin-plugin-test:app.js` `karin-plugin-test:测试转发`
+  disable: []
+
+  # 群、频道成员单独黑名单
+  memberDisable: []
+
+  # 群、频道成员单独白名单
+  memberEnable: []
+
+# 单个Bot全局配置
+Bot:selfId:
+  cd: 0
+  userCD: 1
+  mode: 0
+  alias: []
+  enable: []
+  disable: []
+  memberDisable: []
+  memberEnable: []
+
+# 单个Bot:单个群 配置
+Bot:selfId:groupId:
+  cd: 0
+  userCD: 1
+  mode: 0
+  alias: []
+  enable: []
+  disable: []
+  memberDisable: []
+  memberEnable: []
+
+# 单个Bot:单个频道 配置
+Bot:selfId:guildId:
+  cd: 0
+  userCD: 1
+  mode: 0
+  alias: []
+  enable: []
+  disable: []
+  memberDisable: []
+  memberEnable: []
+
+# 单个Bot:单个频道:单个子频道 配置
+Bot:selfId:guildId:channelId:
+  cd: 0
+  userCD: 1
+  mode: 0
+  alias: []
+  enable: []
+  disable: []
+  memberDisable: []
+  memberEnable: []

package/default/config/pm2.yaml

@@ -0,0 +1,21 @@
+# 日志最多显示1000行
+lines: 1000
+
+apps:
+  - name: karin
+    # 入口文件
+    script: index.js
+    # 自动重启
+    autorestart: true
+    # 重启次数
+    max_restarts: 60
+    # 最大内存限制
+    max_memory_restart: 1G
+    # 重启延迟
+    restart_delay: 2000
+    # 合并日志
+    merge_logs: true
+    # 错误日志
+    error_file: ./logs/pm2_error.log
+    # 输出日志
+    out_file: ./logs/pm2_out.log

package/default/config/redis.yaml

@@ -0,0 +1,19 @@
+# 这里的所有配置会全部传递给redis 详情参数请查阅
+
+# url的优先级是高于下方配置的，如果url没有的参数会读取最下方配置
+# redis[s]://[[username][:password]@][host][:port][/db-number]
+url: redis://127.0.0.1:6379
+
+# 套接字连接属性
+socket:
+  # 地址
+  host: 127.0.0.1
+  # 端口
+  port: 6379
+
+# 用户名
+username:
+# 密码
+password:
+# 数据库索引
+database: 0

package/default/config/server.yaml

@@ -0,0 +1,47 @@
+# 当前文件热更新是否重启http服务
+hmrToServer: false
+
+# 鉴权秘钥
+authKey: ""
+
+# http监听地址
+host: 0.0.0.0
+
+# http端口
+port: 7777
+
+# ws api请求超时时间 秒
+timeout: 60
+
+# onebot http
+onebotHttp:
+  - selfId: default
+    api: http://127.0.0.1:7778
+    # 强烈建议配置 防止恶意伪造事件上报
+    token: ""
+
+# 反向ws鉴权秘钥
+reverseWsToken: ""
+# onebot11 正向WebSocket地址
+forwardWs: []
+
+# websocket 渲染器地址 ws://127.0.0.1:7005/ws/render
+renderWs: []
+# http渲染器地址
+renderHttp: []
+
+# console控制台适配器api配置
+console:
+  # 只允许本地访问
+  isLocal: true
+  # 如果 isLocal 为 false 则需要配置 token
+  token: ""
+  # 自定义host
+  host:
+
+# http根路由随机返回的文案
+rootMsg:
+  - 雪霁银妆素，桔高映琼枝。
+  - 若知是梦何须醒，不比真如一相会。
+  - 一片春愁待酒浇，江上舟摇，楼上帘招。
+  - 人生自是有情痴，此恨不关风与月。

package/default/view/group.yaml

@@ -0,0 +1,73 @@
+name: 群聊配置
+view:
+  - key: 默认配置
+    path: "default"
+    type: "group"
+    part:
+      - key: 消息冷却时间
+        comment: 群聊中所有消息冷却时间，0则无限制
+        path: "default.global_cd"
+        type: "number"
+        suffix: 秒
+        associated:
+          - file: App
+            path: "GroupConfig.GroupCD"
+            requirement: true
+      - key: 个人消息冷却时间
+        comment: 群聊中 每个人的消息冷却时间，0则无限制。注意，开启后所有消息，无论是否触发插件。
+        path: "default.personal_cd"
+        type: "number"
+        suffix: 秒
+        associated:
+          - file: App
+            path: "GroupConfig.GroupUserCD"
+            requirement: true
+      - key: 机器人响应模式
+        comment: 机器人响应模式，0-所有 1-仅@机器人 2-仅回应主人 3-仅回应前缀 4-前缀或@机器人 5-主人无前缀，群员前缀或@机器人
+        path: "default.mode"
+        type: "select"
+        associated:
+          - file: App
+            path: "GroupConfig.mode"
+            requirement: true
+        multiple: false
+        item:
+          - name: 所有
+            value: 0
+          - name: 仅@机器人
+            value: 1
+          - name: 仅回应主人
+            value: 2
+          - name: 仅回应前缀
+            value: 3
+          - name: 前缀或@机器人
+            value: 4
+          - name: 主人无前缀，群员前缀或@机器人
+            value: 5
+      - key: 机器人前缀
+        comment: 机器人前缀 设置后前缀+指令触发机器人
+        path: "default.ailas"
+        type: "array"
+        arrayType: "text"
+        associated:
+          - file: App
+            path: "GroupConfig.alias"
+            requirement: true
+      - key: 白名单插件
+        comment: 白名单插件、功能，只有在白名单中的插件、功能才会响应
+        path: "default.enable"
+        type: "array"
+        arrayType: "text"
+        associated:
+          - file: App
+            path: "GroupConfig.enable"
+            requirement: true
+      - key: 黑名单插件
+        comment: 黑名单插件、功能，黑名单中的插件、功能不会响应
+        path: "default.disable"
+        type: "array"
+        arrayType: "text"
+        associated:
+          - file: App
+            path: "GroupConfig.disable"
+            requirement: true