zhamao-framework/docs/guide/get_started.md
2022-12-26 18:31:27 +08:00

2.6 KiB
Raw Blame History

快速上手

在这里,我们将会以一个基础的复读机为例,帮助你快速熟悉框架的开发流程。

在开始之前,你需要先准备一个可用的 OneBot 机器人实现端(客户端)。

其中一些可用的选项为:

  • Walle-Q
  • 更多…

机器人实现端

机器人实现端与炸毛框架相互独立。关于实现端本身的问题请向对应的开发者反馈。如果你确定相关问题由炸毛框架引起(例如缺少适配或代码问题等)请向我们报告。

框架支持多种通信方式,这里将以反向 WebSocket 为例,即框架充当 WS 服务端,实现端作为 WS 客户端连接到框架。

这里以 Walle-Q 实现端为例,在实际使用中,你可以自由选用不同的实现端。

你可以前往 Walle-Q 的发布页面下载最新的发行版本,并运行以进行初始化。

在登录成功后,请关闭 Walle-Q 以修改配置文件。

首次运行后,将会在当前目录下生成 walle-q.toml 文件。在大多数场景下,这是你唯一需要接触的文件。

在于框架对接的情况中,我们只需要关注 onebot.websocket_rev 配置。

[onebot]
http = []
http_webhook = []
websocket = []

[[onebot.websocket_rev]]
url = "ws://127.0.0.1:20001" # 这里是框架的监听地址
reconnect_interval = 4

修改完成并保存后,重新启动 Walle-Q 并登录即可。如果出现连接失败也请勿惊慌,因为框架此时尚未启动,失败是正常现象。

编写第一个功能

在框架中,几乎所有事件的绑定都是通过注解进行的,详情可以参阅 注解的使用。

让我们在 src/Module/Repeater.php 中开发我们的第一个功能。

namespace Module;

class Repeater
{
	#[BotCommand('echo')]
	public function repeat(OneBotEvent $event, BotContext $context): void
  {
		$context->reply($event->getMessage());
  }
}

借助容器的依赖注入功能,我们可以直接指定相应的类,相关实例会在调用时自动传入。

启动框架

在保存了上述的代码后,你就可以通过 ./zhamao server 启动框架了。

启动后Walle-Q 的日志应当会显示连接成功的信息。

此时,你可以通过任意账号向机器人发送 echo 给我复读 消息,机器人会回复 给我复读

至此,你的第一个功能,复读机,也就开发完成了。

使用机器人 API 和更多事件

如果你希望机器人进行其他复杂的动作(操作),请参见 机器人 API。

关于更多可以注册绑定的事件,请参见 注解事件。