mioku 0.8.13 → 0.8.14
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +95 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,95 @@
|
|
|
1
|
+
# Mioku
|
|
2
|
+
|
|
3
|
+
> AI-powered bot application based on mioki
|
|
4
|
+
|
|
5
|
+
基于 [mioki](https://mioki.viki.moe/) 的聊天机器人框架。
|
|
6
|
+
|
|
7
|
+
## 特性
|
|
8
|
+
|
|
9
|
+
- 🔌 **插件系统** - 支持独立 npm 包管理，支持热插拔
|
|
10
|
+
- 🛠️ **服务架构** - 可复用的服务层，插件声明式依赖
|
|
11
|
+
- 🤖 **AI Skill 系统** - 插件可注册 Skill，包含多个 AI 工具
|
|
12
|
+
- 📚 **帮助系统** - 插件帮助信息自动注册和生成
|
|
13
|
+
- ⚙️ **配置管理** - 插件独立配置，支持热更新
|
|
14
|
+
- 📦 **Workspace 管理** - 使用 bun workspace，插件和服务独立依赖管理
|
|
15
|
+
|
|
16
|
+
## 环境要求
|
|
17
|
+
|
|
18
|
+
- [bun](https://bun.sh/) JavaScript 运行时和包管理工具
|
|
19
|
+
|
|
20
|
+
> 一键安装 bun 命令: `npm install -g bun`
|
|
21
|
+
|
|
22
|
+
- [git](https://git-scm.com/) 用于版本管理和插件安装
|
|
23
|
+
- chromium 内核的浏览器，用于系统截图服务，缺失将无法使用大部分插件功能
|
|
24
|
+
|
|
25
|
+
> 常见支持的浏览器有 Chrome(推荐) / Edge / chromium(Chrome的开源版本)
|
|
26
|
+
|
|
27
|
+
- [ffmpeg](https://ffmpeg.org/) 用于音频与视频处理，部分插件可能用到
|
|
28
|
+
- 一个可连接的 [NapCat](https://doc.napneko.icu/) / [OneBot v11](https://onebot.dev/) 实现端
|
|
29
|
+
|
|
30
|
+
## 快速开始
|
|
31
|
+
|
|
32
|
+
使用 `npx mioku` 一键创建项目：
|
|
33
|
+
|
|
34
|
+
```bash
|
|
35
|
+
npx mioku
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
首次启动时会自动询问 mioki 相关配置字段，并引导你填写 NapCat 正向 WS 配置。
|
|
39
|
+
|
|
40
|
+
首次启动还会询问是否安装 WebUI。
|
|
41
|
+
|
|
42
|
+
> 除了 NapCat，还可以使用其他任何符合 OneBot v11 协议的实现端如 LLTwoBot/Lagrange 等。可能会出现少许兼容性问题。
|
|
43
|
+
|
|
44
|
+
## 启动
|
|
45
|
+
|
|
46
|
+
```bash
|
|
47
|
+
cd <项目名称>
|
|
48
|
+
bun run start
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
## 插件/服务安装
|
|
52
|
+
|
|
53
|
+
> 推荐使用 WebUI 管理插件/服务
|
|
54
|
+
|
|
55
|
+
使用 `npx mioku` 命令安装或更新插件/服务：
|
|
56
|
+
|
|
57
|
+
```bash
|
|
58
|
+
# 安装插件
|
|
59
|
+
npx mioku install plugin <名称>
|
|
60
|
+
# 例如: npx mioku install plugin 60s
|
|
61
|
+
|
|
62
|
+
# 安装服务
|
|
63
|
+
npx mioku install service <名称>
|
|
64
|
+
# 例如: npx mioku install service ai
|
|
65
|
+
|
|
66
|
+
# 更新所有 mioku 相关包
|
|
67
|
+
npx mioku update all
|
|
68
|
+
|
|
69
|
+
# 更新 mioku 框架本身
|
|
70
|
+
npx mioku update self
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
## WebUI
|
|
74
|
+
|
|
75
|
+
WebUI 会随框架自动加载，访问 http://127.0.0.1:3339 进入管理界面。
|
|
76
|
+
|
|
77
|
+
首次启动会提示设置登录密钥。
|
|
78
|
+
|
|
79
|
+
## 开发
|
|
80
|
+
|
|
81
|
+
```bash
|
|
82
|
+
# 开发模式
|
|
83
|
+
bun run dev
|
|
84
|
+
|
|
85
|
+
# 构建 mioku 包
|
|
86
|
+
bun run build
|
|
87
|
+
|
|
88
|
+
# 文档开发
|
|
89
|
+
bun run docs:dev
|
|
90
|
+
bun run docs:build
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
## 许可
|
|
94
|
+
|
|
95
|
+
MIT
|