Skip to content

快速开始

本教程适用全系统,包括但不限于Mac/Win/Linux,只需要打开系统的终端按照教程操作即可 ;]

环境要求

  • 一台服务器,不需要公网,运行内存大于100M即可
  • Node.js 运行环境,推荐使用LTS版本
  • 推荐使用 bun 作为包管理工具,也可使用npm或pnpm等包管理工具

一键安装bun命令: npm install -g bun

  • git 用于版本管理和 WebUI 安装插件等
  • chromium 内核的浏览器,用于系统截图服务,缺失将无法使用大部分插件功能

常见支持的浏览器有 Chrome(推荐) / Edge / chromium(Chrome的开源版本)

安装

以手动安装为例,也支持使用 Docker / Docker Compose 进行安装

bash
git clone https://github.com/Jerryplusy/mioku.git
cd mioku
bun install

启动

bash
bun run start

首次启动

首次启动会引导你填写:

  • NapCat 地址 (正向WebSocket连接,即Mioku作为客户端)
  • NapCat 端口
  • NapCat token
  • 主人 QQ

如果还没安装 WebUI,也会询问是否安装。

示例配置:
NapCat 地址: localhost
Napcat 端口: 7000
NapCat token: 114514
...

稍后也可以自行修改配置文件或前往 WebUI 修改

下一步

开发命令

bash
bun run dev # 开发模式
bun run build # 构建包 通常用于检测是否有问题
bun run docs:dev # 文档开发模式
bun run docs:build # 文档构建

Released under the MIT License with love.