mirai/docs/UserManual.md
米可绫夏 fe649726f3
[docs] 完善了用户文档部分的内容 (#2541)
* 对 README 做了一丢丢改动

把用户和开发者部分的索引分开以便用户区分
调整了一点点细节

* 完善用户手册

补充了简单易懂的安装教程

* 规范 README 文档语法

* Apply suggestions from code review

Co-authored-by: Yurinann <1713574450@qq.com>
Co-authored-by: Him188 <Him188@mamoe.net>

* 规范了用户手册的文档内容

* 订正了一个空格错误

* 订正一个语法错误

* Update docs/UserManual.md

---------

Co-authored-by: Yurinann <1713574450@qq.com>
Co-authored-by: Him188 <Him188@mamoe.net>
2023-03-21 14:57:36 +00:00

2.5 KiB
Raw Blame History

Mirai - UserManual

这里是 Mirai 用户手册。本文面向对开发并不熟悉,但希望使用 Mirai 提供的 QQ 机器人服务支持的用户。 如果你要开发 Mirai 插件或参与贡献 Mirai 项目,请先阅读 开发文档

启动 Mirai

想要部署并使用 Mirai QQ机器人框架只需要启动 Mirai 控制台(即 Mirai Console 它自带一些基础功能,也可以加载社区提供的插件。

Mirai 控制台现在有两个版本Mirai 插件在这两个版本的 Mirai Console 上都可以运行:

类型 长啥样? 好用吗? 怎么装?
纯控制台 MCLI-1.png 稳定,也适合服务器 使用纯控制台版本
图形界面 MCPS-1.png 测试版,不稳定 使用图形界面版本

使用图形界面版本

前往 sonder-joker/mirai-compose 下载适合你的系统的压缩包,

MAC 系统下载 .dmg 后缀的文件
Windows 系统下载 .msi 后缀的文件
Linux 系统下载 .deb 后缀的文件

以 Windows 系统为例,以下为简要安装步骤:

  1. 下载 mirai-compose-<版本>.msi
  2. 双击运行安装程序,选择一个合适的文件夹,然后点击安装
  3. 安装完毕后打开刚才指定的文件夹
  4. 双击启动其中的 mirai-compose.exe 即可开始运行
  5. 运行后点击左上角可以添加 QQ bot 账号

安装插件只需要将下载好的插件置于 plugins 目录,安装完毕后重启 mirai-compose 以生效。

使用纯控制台版本

详细教程请查看 ConsoleTerminal.md

以 Windows 系统为例,以下为简要安装步骤:

  1. 前往 iTXTech/mcl-installer 下载适合您系统的最新版本的 MCL 安装器
  2. 创建好文件夹之后,将 MCL 安装器移动到其中
  3. 双击 mcl-installer.exe 过程中只需要按几次回车键,即可安装完毕
  4. 运行 mcl.cmd 即可启动 MCL 控制台

安装插件只需要将下载好的插件置于 plugins 目录,然后重启 MCL 控制台即可。

解决问题

如果遇到使用问题或想提建议,可以在 issues 发表。也可以在论坛交流想法。