Skip to content

docs(character): 补充推荐插件说明#35

Merged
CookSleep merged 1 commit into
ChatLunaLab:mainfrom
CookSleep:docs/update-character-recommended-plugins
Jun 3, 2026
Merged

docs(character): 补充推荐插件说明#35
CookSleep merged 1 commit into
ChatLunaLab:mainfrom
CookSleep:docs/update-character-recommended-plugins

Conversation

@CookSleep
Copy link
Copy Markdown
Member

@CookSleep CookSleep commented Jun 3, 2026

摘要

  • 新增伪装推荐插件最佳实践文档,并加入侧栏入口
  • 将默认预设中的长插件说明改为链接到推荐插件文档
  • 补充伪装插件文档、快速上手安装提示与依赖配置提醒

校验

  • 未运行构建,仅文档改动

Summary by CodeRabbit

  • Documentation
    • Added new best-practice guide for recommended plugins in the Character plugin scenario, organized by plugin tier with configuration recommendations.
    • Updated getting-started guide with improved installation instructions and clarified plugin configuration workflow.
    • Enhanced Character plugin documentation with clarifications about preset-specific guidance.
    • Updated documentation links to reference the new best-practice page.

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Jun 3, 2026

Review Change Stack

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 1263a8d1-260f-4700-839f-cb08ee6a259d

📥 Commits

Reviewing files that changed from the base of the PR and between 61cc62e and 0ef2f82.

📒 Files selected for processing (6)
  • docs/.vitepress/config.ts
  • docs/ecosystem/other/character.md
  • docs/guide/best-practice/character-recommended-plugins.md
  • docs/guide/getting-started.md
  • docs/public/resources/character_preset.yml
  • docs/public/resources/character_preset_tool_call.yml

📝 Walkthrough

Walkthrough

This PR introduces a centralized best-practice guide for recommended plugins when using ChatLuna's Character preset, consolidates previously duplicated plugin installation instructions from preset templates and configuration guides, and updates documentation to cross-reference the new guide instead of maintaining separate lists.

Changes

ChatLuna Character Plugin Recommendations Guide

Layer / File(s) Summary
New best-practice plugin recommendation guide
docs/guide/best-practice/character-recommended-plugins.md
New comprehensive guide document with structured plugin categories (foundation, extension, advanced, other), configuration recommendations per plugin (context/session options, storage/path setup, tool-calling and protocol-specific enablement, memory and vector database configuration), use reminders, and voice service guidance.
Navigation sidebar and preset integration
docs/.vitepress/config.ts, docs/public/resources/character_preset.yml, docs/public/resources/character_preset_tool_call.yml
Adds sidebar navigation entry for the new guide under "最佳实践", updates both character preset YAML headers with new timestamps and replaces inline plugin lists with links to the centralized guide.
Documentation improvements and preset clarifications
docs/ecosystem/other/character.md, docs/guide/getting-started.md
Adds warning note about preset-specific guidance differences (particularly for tool-calling replies and chatluna-toolbox configuration), recommends a project template for Koishi setup, and clarifies that plugin configuration must be manually generated after installation.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

  • ChatLunaLab/doc#12: Both PRs modify Character documentation and preset materials to align setup guidance with recommended plugin details.
  • ChatLunaLab/doc#4: Both PRs modify docs/.vitepress/config.ts sidebar entries under sidebarGuide().
  • ChatLunaLab/doc#23: Both PRs update docs/public/resources/character_preset.yml usage text and plugin guidance content.

Suggested reviewers

  • dingyi222666

Poem

🐰 A guide to plugins, neat and bright,
Presets now point to one true sight,
No more lists scattered here and there,
Character config beyond compare! 🎭✨

✨ 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.

@CookSleep CookSleep merged commit 17b6c93 into ChatLunaLab:main Jun 3, 2026
1 check was pending
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 introduces a new documentation page detailing recommended plugins and configurations for ChatLuna, replacing the inline plugin recommendations in the character preset YAML files with a link to this new page. It also updates the getting started guide with a template project link and adds sidebar navigation for the new page. The review feedback focuses on improving the new documentation file, suggesting formatting consistency (such as wrapping URLs and plugin names in backticks) and refining some descriptions to be more formal and objective.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

- 将"Koishi 在公网或者局域网中的路径"改为你的环境中实际的路径,确保此路径可以被你的 NapCat 或 LLBot 正常访问:
- **Linux Docker 部署:**
- 若 Koishi 与你的 NapCat 或 LLBot 使用 Docker 部署在同一个容器中,请尝试保持默认地址 `http://127.0.0.1:5140`,不要修改
- 若 Koishi 与你的 NapCat 或 LLBot 使用 Docker 部署在不同容器中、但使用同一个 Docker 网桥时,可以填写 `http://koishi:5140`,5140 为你的 Koishi 容器内端口
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

为了保持文档格式的一致性,并防止 Markdown 解析器将其误识别为普通文本链接,建议将 http://koishi:5140 用反引号包裹。修改后的效果如下:

- 若 Koishi 与你的 NapCat 或 LLBot 使用 Docker 部署在不同容器中、但使用同一个 Docker 网桥时,可以填写 \http://koishi:5140\`,5140 为你的 Koishi 容器内端口`


- 只启用"群管插件",其他选项全部关闭
- 在"群管插件配置"中配置好:
- "允许使用群管功能的成员 ID 列表"(可以要求 Bot 使用群管功能的人)
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

“可以要求 Bot 使用群管功能的人”表述略显口语化,建议修改为更书面、清晰的表述,例如“即允许指挥 Bot 执行群管操作的用户 ID 列表”。

Suggested change
- "允许使用群管功能的成员 ID 列表"(可以要求 Bot 使用群管功能的人
- "允许使用群管功能的成员 ID 列表"(即允许指挥 Bot 执行群管操作的用户 ID 列表


提供丰富的媒体生成能力(包括文本生成图片、图片生成图片、音频生成、视频生成),搭配适当的配置可以实现用 AI 生成图片等需求。

该项目的 WebUI 有待改进。
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

“该项目的 WebUI 有待改进”表述较为主观。建议使用更客观、建设性的语言来描述,例如“该项目的 WebUI 仍在完善中”。

Suggested change
该项目的 WebUI 有待改进
该项目的 WebUI 仍在完善中


**推荐配置:**

- 语音服务请自行寻找合适的插件或尝试使用 `media-luna`
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

为了与文档中其他插件名称(如 chatluna-toolboxmemesluna 等)的格式保持一致,建议将 media-luna 用反引号包裹。修改后的效果如下:

- 语音服务请自行寻找合适的插件或尝试使用 \media-luna``

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