Compare commits

..

2 Commits
v1.0.0 ... main

Author SHA1 Message Date
10534d64f2 🚀 docs(README.md): Update plugin configuration instructions for compatibility with Guoba. 2026-01-08 13:18:27 +08:00
Jerry
2e1d113298
Merge pull request #14 from Jerryplusy/dev
Fix the new API proxy issue (resolves #13) and add support for Guoba
2026-01-08 13:02:49 +08:00

202
README.md
View File

@ -132,208 +132,10 @@
</details> </details>
## 插件配置 ## 插件配置
本插件暂未适配锅巴,请前往云崽根目录 `data/crystelf` 中修改配置文件
**配置文件已启用热更新,请不要修改插件目录下 `config` 文件夹中的文件**
<details> ## **本插件已适配锅巴,请务必使用锅巴进行插件配置**
<summary>各模块配置文件解析</summary>
修改时请勿携带注释 `//`
只对需要注意的配置项进行解析,没有出现的配置项或配置文件可能是为以后的升级预留或不重要
<details>
<summary>config.json</summary>
``` **请不要修改插件目录下 `config` 文件夹中的文件**
{
"maxFeed": 10,//使用rss推送功能时,本地记录的最长长度,用于检测最新文章
//功能是否启用
"?autoUpdate": "是否自动更新插件",
"autoUpdate": true,
"poke": true,
"60s": true,
"fanqie": true,
"zwa": true,
"rss": true,
"help": true,
"welcome": true,
"faceReply": true,
"ai": true,
"blackWords": true,
"music": true,
"auth": true
}
```
</details>
<details>
<summary>60s.json</summary>
```
{
"url": "https://60s.viki.moe" //60s基础api,用于调取每日新闻,可以自行部署
}
```
</details>
<details>
<summary>auth.json</summary>
```
{
"url": "https://carbon.crystelf.top",//手性碳api地址,可以自建,也可以用我们提供的api
//默认配置
"default": {
"enable": false,//在每个群是否启用
"carbon": {//手性碳配置
"enable": false,//是否启用手性碳验证,false则为数字验证
"hint": true,//是否提示手性碳位置
"hard-mode": false //是否启用困难模式,该模式下需要回答全部位置的手性碳
},
"timeout": 180,//超时时间(s)
"recall": true,//是否撤回错误答案
"frequency": 5 //最大尝试次数
}
}
```
</details>
<details>
<summary>coreConfig.json</summary>
```
{
"coreUrl": "https://core.crystelf.top",//晶灵核心地址,某些功能如早晚安问候,戳一戳,晶灵智能等需要使用到
"token": "" //验证api,可忽略
}
```
</details>
<details>
<summary>poke.json</summary>
```
{
"replyPoke": 0.4 //被戳回戳概率
}
```
</details>
<details>
<summary>profile.json</summary>
```
{
"nickName": "鸡气人" //你的bot的昵称
}
```
</details>
<details>
<summary>music.json</summary>
```
{
"?url": "api地址,不建议修改",
"url": "https://api.401658.xyz",
"?username&&password": "请勿修改",
"username": "crystelf",
"password": "1145141919810",
"?quality": "1为96kbpsAAC,2为320kbpsAAC,3为最高16-bit/44.1kHzflac",
"quality": "3"
}
```
</details>
<details>
<summary>ai.json</summary>
```
{
"?mode": "对话模式,mix为混合,ai为纯人工智能,keyword为纯关键词",
"mode": "mix", //mix模式下,会在消息长度小于maxMix时查找其中的关键词进行回复,以达到节省token的效果
"baseApi": "https://api.siliconflow.cn/v1", //baseapi地址,需支持openai协议
"apiKey": "", //你的api密钥
"?modelType": "模型名称,请根据baseApi填写的服务商的对应的模型",
"modelType": "deepseek-ai/DeepSeek-V3.2-Exp",
"?multimodalEnabled": "是否启用多模态模型模式,启用后将忽略文本模型",//开启多模态模式后,将默认使用多模态模型回复
"multimodalEnabled": false,//多模态模式可以处理视频,图片等
"?multimodalModel": "多模态模型名称",
"multimodalModel": "Qwen/Qwen2.5-VL-72B-Instruct",
"?temperature": "聊天温度,可选0-2.0,温度越高创造性越高",
"temperature": 1.2,
"?concurrency": "最大同时聊天群数,一个群最多一个人聊天",
"concurrency": 3,
"?maxMix": "mix模式下,如果用户消息长度大于这个值,那么使用ai回复",
"maxMix": 5,
"?timeout": "记忆默认超时时间(天)",
"timeout": 30,
"?maxSessions": "最大同时存在的sessions群聊数量",
"maxSessions": 10,
"?chatHistory": "聊天上下文最大长度",
"chatHistory": 10,
"?maxMessageLength": "最大消息长度,如果消息长度大于这个值,超出的部分将会被截断",
"maxMessageLength": 100,
"?getChatHistoryLength": "获取到的聊天上下文长度,ai可以看到多少条群聊的聊天记录",
"getChatHistoryLength":20,
"?blockGroup": "禁用的群聊(黑名单)",
"blockGroup": [],
"?whiteGroup": "白名单群聊,存在该部分时,黑名单将被禁用",
"whiteGroup": [],
"?character": "回复表情包时的角色",
"character": "zhenxun", //目前晶灵核心仅有zhenxun角色,后续可能会增加更多角色
"?botPersona": "机器人人设描述",
"botPersona": "你是一个名为晶灵的智能助手,性格温和友善,喜欢帮助用户解决问题.知识渊博,能够回答各种问题,偶尔会使用一些可爱的表情和语气.会记住与用户的对话内容,提供个性化的回复.",
"?codeRenderer": "代码渲染配置",
"codeRenderer": {
"theme": "github",
"fontSize": 14,
"lineNumbers": true,
"backgroundColor": "#f6f8fa"
},
"?markdownRenderer": "Markdown渲染配置",
"markdownRenderer": {
"theme": "dark",
"fontSize": 14,
"codeTheme": "github"
},
"?imageConfig": "图像生成配置",
"imageConfig": {
"?enabled": "是否启用图像生成功能",
"enabled": true,
"?imageMode": "图像生成模式: 'openai'使用/v1/images/generations接口, 'chat'使用对话式生图模型(如gemini-3-pro-image-preview)",
"imageMode": "openai",
"?model": "图像生成模型名称(支持gemini-3-pro-image-preview等)",
"model": "gemini-3-pro-image-preview",
"?baseApi": "图像生成API基础地址(不加v1后面的)",
"baseApi": "https://api.uniapi.io",
"?apiKey": "图像生成API密钥",
"apiKey": "",
"?timeout": "图像生成超时时间(豪秒)",
"timeout": 60000,
"?maxRetries": "最大重试次数",
"maxRetries": 3,
"?quality": "生成图像质量(standard/high)",
"quality": "standard",
"?style": "图像风格(natural/vivid)",
"style": "natural",
"?size": "生成图像尺寸(1024x1024/1792x1024/...)",
"size": "1024x1024",
"?responseFormat": "响应格式(url/b64_json)",
"responseFormat": "url",
"?modalities": "模态类型(text/image)",
"modalities": ["text", "image"]
}
}
```
</details>
</details>
## 关于晶灵核心 ## 关于晶灵核心
晶灵核心是一个开源的api服务,使用nestjs框架编写,本插件部分功能依赖于晶灵核心,如戳一戳,早晚安,晶灵智能等. 晶灵核心是一个开源的api服务,使用nestjs框架编写,本插件部分功能依赖于晶灵核心,如戳一戳,早晚安,晶灵智能等.