MiraiBot

⭐ 一个基于 Mirai 的控制台机器人。 ⭐

声明

一切开发旨在学习, 请勿用于非法用途

• MiraiBot 是一款免费且开放源代码的软件, 仅供学习和娱乐用途使用.
• MiraiBot 不会通过任何方式强制收取费用, 或对使用者提出物质条件.
• MiraiBot 由整个开源社区维护, 并不是属于某个个体的作品, 所有贡献者都享有其作品的著作权.

许可证

详见 https://github.com/1689295608/MiraiBot/blob/main/LICENSE

MiraiBot 继承 Mirai 使用 AGPLv3 协议开源. 为了整个社区的良性发展, 我们强烈建议您做到以下几点:

• 间接接触到 MiraiBot 的软件使用 AGPLv3 开源
• 不鼓励, 不支持一切商业使用

若因您对 MiraiBot 的不当使用而导致您的任何损失, 该软件 及 该软件开发者不负任何责任

衍生软件需声明引用

• 若引用 MiraiBot 发布的软件包而不修改 MiraiBot, 则衍生项目需相关内容首次出现的部位明确申明来源于本仓库 (MiraiBot).
• 若修改 MiraiBot 源代码再发布, 或参考 MiraiBot 内部实现发布另一个项目, 则衍生项目必须在文章首部或 'MiraiBot' 相关内容首次出现的位置明确声明来源于本仓库 (MiraiBot). 不得扭曲或隐藏免费且开源的事实.

MiraiBot 特性

• [x] 多语言支持（目前支持 简体中文、英文）
• [x] 发送私聊消息
• [x] 发送群聊消息
• [x] 踢出群成员
• [x] 群聊戳一戳某人
• [x] 禁言群成员
• [x] 解除禁言群成员
• [x] 发送语音
• [x] 发送图片
• [x] 上传图片
• [x] 上传剪切板图片
• [x] 创建文字图片 (beta)
• [x] 删除好友
• [x] 回复群消息
• [x] 修改群昵称
• [x] 撤回消息以及群消息
• [x] 多群切换
• [x] 网易云音乐分享
• [x] 发送自定义骰子
• [x] 退出群聊
• [x] 设置群昵称
• [x] 合并消息转发
• [x] 插件系统 (beta)

开始使用

接下来会手把手教你如何开始使用 MiraiBot

首先：

本项目基于 JDK 17 开发, 所以请使用 JDK 17 及以上的 Java 运行本程序!

请前往 MiraiCore-Release 下载最新的 MiraiCore 独立包 （如果使用的版本低于 1.2.1 可以跳过这个步骤）

然后在 Release 下载最新版的 MiraiBot.jar 文件

如需最新的由 Github Action 构建的开发版，请在 Release 下载带有 AutoBuild 前缀的版本 开发版并不能确保使用的稳定性，除非你知道你在干什么，否则建议不要使用开发版！

然后将其解压到任意文件夹内 ( 不推荐包含特殊字符的文件夹及路径 ) 后

将下载好的 MiraiCore 放入该文件夹，这个文件在启动脚本里需要用到

Windows 用户

在解压到的文件夹中新建一个 .bat Windows 批处理文件

以下为示例脚本，仅供参考：

@echo off
java -classpath MiraiBot.jar;MiraiCore.jar com.windowx.miraibot.MiraiBot
pause
exit

其中 MiraiBot.jar 和 MiraiCore.jar 便是你下载的文件了

保存并运行该脚本即可开始使用 MiraiBot！

登录时如果这个 device.json 没有登录过这个 QQ 那么一般情况下会进行设备锁验证

那将会弹出一个窗口，一般是一个链接，如果你有手机 QQ 那么推荐使用 QQ 内置浏览器打开

因为那样就可以进行人脸验证（如果没开启就没有）

在电脑浏览器打开也可以，可以进行 QQ 扫码验证 需要登录该 QQ 的手机 QQ 扫码授权

如果近几天没有使用账户信息辅助验证，那么也可以进行账户信息辅助验证来登录该 QQ

Linux 用户

Linux 用户首先需要在 MiraiBot 目录运行一个终端

然后新建一个 .sh 的 Bash Shell 文件（例如 touch Start.sh）

再写入执行脚本内容（例如 vi Start.sh），以下为示例脚本，仅供参考：

java -classpath MiraiBot.jar:MiraiCore.jar com.windowx.miraibot.MiraiBot

其中 MiraiBot.jar 和 MiraiCore.jar 便是你下载的文件了

保存并运行该脚本即可开始使用 MiraiBot！（例如 bash Start.sh）

如果您的 Linux 有可视化环境，那么可以按照 Windows 用户方法进行设备锁验证

反之，你可以尝试通过 MiraiAndroid 来进行设备锁验证

你可以使用两种方法来生产 device.json：

1. 将您当前的 device.json 导入到 MiraiAndroid
2. 将 MiraiAndroid 的 device.json 应用于当前

这两个的区别在于，如果你当前的 device.json 需要用于其他用处不想被覆盖，则可以导入当前 device.json 到 MiraiAndroid

将您当前的 device.json 导入到 MiraiAndroid

首先将当前的 device.json 通过任何方式传输到你的手机中

然后在你的手机打开 MiraiAndroid，点击左上角菜单按钮，在弹出的菜单中选择 工具 选项卡

然后点击 导入 DEVICE.JSON，然后选择你刚才传输到你手机中的 device.json

最后使用 MiraiAndroid 登录一次你的 QQ 即可

将 MiraiAndroid 的 device.json 应用于当前

首先在你的手机上打开 MiraiAndroid

然后登录并进行相应验证后

点击左上角菜单按钮，在弹出的菜单中选择 工具 选项卡

点击 导出 DEVICE.JSON 然后选择保存位置后

将这个 device.json 传输到你的 Linux 中，替换你当前的 device.json

再次登录即可成功登录

开发

若您有意愿开发属于自己的 MiraiBot 插件，可到 MiraiBot Docs 查看并学习

我们强烈建议基于 MiraiBot 开发的插件使用相同的协议开放源代码交流学习

感谢支持！

常见问题疑难解答

Q：Error: A JNI error has occurred, please check your installation and try again
A：请使用 OpenJDK，而不是 Oracle Java

Q：QQ 账号安全性有保障吗
A：不相信的话可以直接查源代码的说

Q：会被封号吗
A：MiraiBot 的行为和正常 QQ 十分相似，不发布违规内容等理论不会被封

Q：This class is moved, please use 'com.windowx.miraibot.MiraiBot'!
A：请将启动脚本中的 `com.windowx.miraibot.PluginMain` 改为 `com.windowx.miraibot.MiraiBot`