开发指南

字数

714 字

阅读时间

3 分钟

本指南面向需要在 ChatLuna v2 上编写插件 (Plugin) 或扩展系统能力的开发者。

通过 ChatLuna 的扩展机制，你可以完成以下工作：

• 注册工具与技能
• 接入新的模型提供商 (Provider)
• 添加 WebUI 页面
• 定义路由命名空间
• 深入 Cordis 生命周期，编写自定义服务 (Service)

文档按照「跑通最小插件 → 学习框架基础概念 → 按能力分类扩展」的递进顺序组织。

前置知识

开发 ChatLuna 插件需要具备基础的 TypeScript 知识。

ChatLuna 基于 Cordis 4 框架构建。插件可以向共享的上下文 (Context) 注入服务、监听事件并声明可逆的副作用 (Effect)。通过上下文注册的所有资源，都会在插件卸载时由框架自动回收。

路线规划

你可以根据当前的开发需求查阅对应模块：

开发起步

从零搭建环境并运行插件：

1. 环境搭建：准备本地开发环境与运行依赖。
2. 配置文件：了解项目配置项的结构与加载机制。
3. 第一个插件：创建并运行一个最小的 ChatLuna 插件。
4. 发布插件：打包并分发你的插件。

框架基础

深入了解 Cordis 运行机制与核心接口：

• 插件与生命周期：掌握插件的加载、启动与卸载时机。
• 服务与依赖：声明插件依赖并注册全局共享服务。
• 事件系统：监听与派发系统生命周期及运行时事件。
• 配置构型：定义供用户配置的模式规范 (Schema)。

能力扩展

按需接入具体业务功能：

• 工具：向模型注册可调用的外部工具与技能。
• 提示词分区：定义提示词分区与上下文构建规则。
• 引擎：编写自定义引擎，接管一轮对话的编排方式。
• 路由命名空间：为插件声明可按群、按用户配置的命名空间。
• 模型提供商：适配并接入自定义的大语言模型后端。
• 平台适配器：接入新的聊天平台。
• 存储：读写实例内的持久化数据。
• WebUI：扩展控制台前端页面与交互组件。
• 测试：为插件编写可重复执行的测试。

下一步

开始搭建你的开发工作区：

• 前往 环境搭建 完成项目初始化。