Skip to content

docs(character): 同步最新配置结构与默认预设说明#21

Merged
CookSleep merged 1 commit intoChatLunaLab:mainfrom
CookSleep:docs/character-config-sync-20260329
Mar 28, 2026
Merged

docs(character): 同步最新配置结构与默认预设说明#21
CookSleep merged 1 commit intoChatLunaLab:mainfrom
CookSleep:docs/character-config-sync-20260329

Conversation

@CookSleep
Copy link
Copy Markdown
Member

@CookSleep CookSleep commented Mar 28, 2026

总结

  • 同步伪装插件最新配置结构说明,补全文档中的全局配置与分会话覆盖字段。
  • 更新默认预设注释,修正配置位置说明并补充文件消息示例。

Summary by CodeRabbit

  • Documentation
    • Updated configuration documentation structure to reflect the new configuration hierarchy model.
    • Enhanced plugin setup instructions with clearer guidance on OneBot protocol selection and session configuration.
    • Expanded output format specifications with new examples for file messages and improved formatting guidance.
    • Clarified message interval settings, trigger controls, and whitelist behavior in configuration documentation.

@CookSleep CookSleep merged commit 5e3af14 into ChatLunaLab:main Mar 28, 2026
1 check was pending
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Mar 28, 2026

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 693bfab2-05ac-4143-8e87-2966299205db

📥 Commits

Reviewing files that changed from the base of the PR and between fc91f08 and dbcb59c.

📒 Files selected for processing (2)
  • docs/ecosystem/other/character.md
  • docs/public/resources/character_preset.yml

📝 Walkthrough

Walkthrough

Updated documentation for ChatLuna character configuration and presets. Restructured character.md to reflect a new configuration hierarchy with global and session-level overrides. Updated character_preset.yml with revised plugin guidance, output format examples, and configuration clarifications.

Changes

Cohort / File(s) Summary
Character Configuration Schema
docs/ecosystem/other/character.md
Restructured documentation from legacy top-level model references to a new "基础配置 + 全局私聊配置 + 全局群聊配置 + 分会话覆盖" hierarchy. Introduced new global config blocks (globalPrivateConfig, globalGroupConfig) with trigger controls (enableFixedIntervalTrigger, messageInterval, idleTrigger). Expanded whitelist modes (privateWhitelistMode, groupWhitelistMode) and clarified mute_keyword, privateConfigs, and isAt field placement and behavior.
Character Preset Documentation
docs/public/resources/character_preset.yml
Enhanced plugin setup instructions with OneBot protocol guidance and enableMessageId context clarification. Added optional chatluna-agent section. Updated "重要提醒" examples (Markdown/file/sticker handling), refined Gemini adapter requirements, added "文件消息" output format example, and improved message-interval conflict avoidance guidance.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~18 minutes

Possibly related PRs

Suggested reviewers

  • dingyi222666

Poem

🐰 Configuration paths, reorganized with care,
Global and private, now laid out fair,
New schemas bloom where old ones rest,
Presets refined, documentation's best! 📝

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request updates the character plugin documentation to reflect a new configuration structure consisting of base, global, and session-specific settings. It also enhances the character preset template with updated protocol instructions, a file message example, and logic for handling message intervals. The review feedback suggests maintaining documentation consistency by adding terminal punctuation to descriptive comments within the YAML preset.

Comment on lines +32 to 37
# - 若 Koishi 与你的 Napcat 或 LLBot 使用Docker部署在同一个容器中,请尝试保持默认地址“http://127.0.0.1:5140”,不要修改
# - 若 Koishi 与你的 Napcat 或 LLBot 使用Docker部署在不同容器中、但使用同一个 Docker 网桥时,可以填写“http://koishi:5140”,5140 为你的 Koishi 容器内端口
# - 如果不会,请尝试咨询AI
# - 不建议使用容器在宿主机的内网IP连接,因为容器的内网IP可能会在重启后重新分配,导致原有连接断开
# - 其他部署:
# - 其他部署方案(如Windows),请尝试保持默认地址“http://127.0.0.1:5140”,不要修改
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

为了保持文档注释的格式统一,建议在这些说明性语句的末尾添加中文句号“。”。

#         - 若 Koishi 与你的 Napcat 或 LLBot 使用Docker部署在同一个容器中,请尝试保持默认地址“http://127.0.0.1:5140”,不要修改。
#         - 若 Koishi 与你的 Napcat 或 LLBot 使用Docker部署在不同容器中、但使用同一个 Docker 网桥时,可以填写“http://koishi:5140”,5140 为你的 Koishi 容器内端口。
#           - 如果不会,请尝试咨询AI。
#           - 不建议使用容器在宿主机的内网IP连接,因为容器的内网IP可能会在重启后重新分配,导致原有连接断开。
#       - 其他部署:
#          - 其他部署方案(如Windows),请尝试保持默认地址“http://127.0.0.1:5140”,不要修改。

Comment on lines +41 to +49
# - Gemini API 请求地址末尾需添加 /v1beta
# - chatluna-multimodal-service(可选,使用 Gemini 或不支持图像输入的模型时推荐)
# - 插件用途:提供图像描述服务、图像及文件(含视频)读取/描述工具
# - 配置说明:
# - 若使用 Gemini,可以启用 enableImageReadTool、enableFileReadTool
# - 若使用不支持图像输入的模型(如 DeepSeek),可以启用 enableContextImageDescription、enableImageReadTool,并在图像描述服务设置中配置一个支持图像输入的模型以生成图像描述
# - chatluna-agent(可选,用于进行文件处理、使用子Agent节约时间和token开销等用途)
# - 插件用途:提供丰富的Agent相关能力(Skill、子Agent、沙盒……)
# - 配置说明:此插件暂未达到稳定可用状态,不推荐使用
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

为了保持文档注释的格式统一,建议在这些说明性语句的末尾添加中文句号“。”。

#     - Gemini API 请求地址末尾需添加 /v1beta。
# - chatluna-multimodal-service(可选,使用 Gemini 或不支持图像输入的模型时推荐)
#   - 插件用途:提供图像描述服务、图像及文件(含视频)读取/描述工具
#   - 配置说明:
#     - 若使用 Gemini,可以启用 enableImageReadTool、enableFileReadTool。
#     - 若使用不支持图像输入的模型(如 DeepSeek),可以启用 enableContextImageDescription、enableImageReadTool,并在图像描述服务设置中配置一个支持图像输入的模型以生成图像描述。
# - chatluna-agent(可选,用于进行文件处理、使用子Agent节约时间和token开销等用途)
#   - 插件用途:提供丰富的Agent相关能力(Skill、子Agent、沙盒……)
#   - 配置说明:此插件暂未达到稳定可用状态,不推荐使用。

Comment on lines 61 to +67
# - 请在使用前自行修改其中的“CHARACTER”、“MASTER”、“USER”、“记!得!改!这!里!的!ID!”、“example.com”、“大部分群友的id及详细信息”等内容为你自己的
# - 如果使用私聊,可复制一份本预设并删改部分信息
# - 确保各种涉及工具的内容已经配置妥当、Bot拥有相关权限
# - 若没有安装对应的插件或是无管理员权限、不是官方Bot而无法发送Markdown消息等,请自行根据情况删改预设中的描述!尤其是表情包相关!
# - <think>部分的示例内容可以在Bot运行一段时间后挑一些看起来比较好的思考内容放进去
# - 如果你在使用官方 Bot 进行私聊(目前伪装插件对于官方 Bot 仅支持私聊),请开启Koishi插件 inspect,并向Bot发送 inspect,将其中“用户ID”的值填写至 chatluna-character 的“应用到的私聊”配置中
# - 如果固定间隔触发中的消息间隔设定为 0,将会启用发言等待功能,建议删去预设中的 next_reply 相关内容避免冲突
# - 确保各种涉及工具的内容已经配置妥当、Bot 拥有相关权限
# - 若没有安装对应的插件或是无管理员权限、不是官方 Bot 而无法发送 Markdown 消息等,请自行根据情况删改预设中的描述!如:表情包、Markdown 消息、文件消息等!
# - <think> 部分的示例内容可以在 Bot 运行一段时间后挑一些看起来比较好的思考内容放进去
# - 如果你在使用官方 Bot 进行私聊(目前伪装插件对于官方 Bot 仅支持私聊),请开启Koishi插件 inspect,并向 Bot 发送 inspect,将其中“用户ID”的值填写至 chatluna-character 的“应用到的私聊”配置中
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

为了保持文档注释的格式统一,建议在这些说明性语句的末尾添加中文句号“。”(已包含感叹号的除外)。

# - 请在使用前自行修改其中的“CHARACTER”、“MASTER”、“USER”、“记!得!改!这!里!的!ID!”、“example.com”、“大部分群友的id及详细信息”等内容为你自己的。
# - 如果使用私聊,可复制一份本预设并删改部分信息。
#   - 如果固定间隔触发中的消息间隔设定为 0,将会启用发言等待功能,建议删去预设中的 next_reply 相关内容避免冲突。
# - 确保各种涉及工具的内容已经配置妥当、Bot 拥有相关权限。
# - 若没有安装对应的插件或是无管理员权限、不是官方 Bot 而无法发送 Markdown 消息等,请自行根据情况删改预设中的描述!如:表情包、Markdown 消息、文件消息等!
# - <think> 部分的示例内容可以在 Bot 运行一段时间后挑一些看起来比较好的思考内容放进去。
# - 如果你在使用官方 Bot 进行私聊(目前伪装插件对于官方 Bot 仅支持私聊),请开启Koishi插件 inspect,并向 Bot 发送 inspect,将其中“用户ID”的值填写至 chatluna-character 的“应用到的私聊”配置中。

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant