Skip to content

MR-XieXuan/MiraiTravel

Repository files navigation

Fork me on GitHub

logo

MiraiTravel


简介 Information

MiraiTravel 是一个运行于 PHP 环境的 功能强大的QQ机器人框架。基于 Mirai-api-http .。

!! 注意 由于 Mirai-api-http 的 webhook 失效 临时解决方案为 :
将 webhook.php 中
$webhookBeUsed = false;
注释掉

这样子MiraiTravel就不会使用webhook适配器

为何开发 MiraiTravel

  1. 安装配置简单 可以通过控制台使用命令行进行 MiraiTravel 的配置。
  2. 兼容性强 可以在任何装有 PHP 的机器上运行,除了PHP,没有其他任何其他不必要的依赖。
  3. 账号分离 可以在一个 MiraiTravel 中实现分离管理多个账号。
  4. 多入口 有 MiraiTravel 控制台入口 和 Webhook 入口。
  5. 易于开发 可以开发组件或者是QQBot脚本来实现自己想实现的功能。
  6. 开发隔离 多命名空间隔离 定义函数或变量不会出现重复导致干扰的问题。
  7. 稳定 发现组件或者脚本出现异常会取消组件或者脚本的实例化。
  8. 全开源 该项目全由PHP编写,由于PHP的特殊性 所以开发时你可以看到程序的所有源代码 哪怕没有文档也可快速开发。

开始 Start

运行 php MiraiTravel.php 即可启动 MiraiTravel。
启动后使用命令 help 可以获取帮助。

开启伪静态

伪静态配置文件为 .htaccess 请按需获取你HttpServer的配置。
如果你MiraiTravel暴露在公网中,不开启伪静态可能会导致你的QQ被恶意利用等。所以我强烈建议你开启伪静态。

首次使用

需要编写一个你的机器人脚本以开始运行。

MiraiTravel 需要获取使用 shell_exec 函数的权限。
所以请你在配置文件中取消禁用 shell_exec 函数。

注意,你应该给项目的所有文件以及文件夹配置权限 777 , 否则可能会有日志文件或者数据文件读取,写入失败的情况发生。

在 script 文件夹中创建文件 Q【你的QQ】.php
参照 Q2771717841.php 文件编写你的机器人脚本。
你可以把 任何出现 2771717841 的地方 改成你的QQ 号。以快速的运行。

您可以手动修改 data/miraiTravel.data 文件以只在使用这个框架。
基础配置项已在该配置文件中有 改成需要的配置即可。

文档均在 文件夹 docs 中 。
阅读 MiraiTravel
阅读 QQBot

项目文件结构

  • core 核心文件
  • data 运行时的数据存储文件
  • logs 运行日志文件
  • components 组件安装路径
  • plugins 插件安装路径
  • script 脚本文件
  • docs 文档

教程会在 : https://blog.csdn.net/apple_53792700/category_12176569.html

交流群 : 604568448

Stargazers over time

Stargazers over time


该项目与 MiraiEz 为兄弟项目。

本项目与MiraiEz的区别如下。

功能与特性 MiraiTravel MiraiEz
开发机制 开发每个QQ独立的脚本 开发通用的插件
API函数实现 类方法 全局函数
是否有命名空间
命令注册 插件可注册,脚本不必要注册 可注册
插件 由脚本进行变种 原生开发方向
调试反馈机制 日志 QQ消息反馈与日志
插件致命错误错误方式 取消插件载入 程序终止运行
基本配置方式 控制台命令配置 修改PHP文件配置
多QQ的处理 通过不同的脚本处理不同的QQ 由插件判断

GitHub last commit (branch) GitHub top language GitHub code size in bytes
Github License GitHub all releases GitHub Repo stars

About

MiraiTravel 是一个运行于 PHP 环境的 功能强大的QQ机器人框架。基于 Mirai-api-http .

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Languages