chipslays/litegram

简单的、灵活的、模块化的 Telegram Bot Api 库。

3.0.17 2023-08-08 05:46 UTC

README

GitHub Workflow Status GitHub

v3.x 正在 开发中,但可以使用。

基于事件的简单、灵活、模块化 Telegram Bot Api 库。

Litegram 可以作为一个轻量级的库使用,也可以作为一个带有插件的功能框架。

⭐ 功能

  • 基于事件(路由);
  • 缓存(Redis、Memcached);
  • 数据库(基于 Laravel 数据库 + Eloquent);
  • 中间件;
  • 本地化(基于 Phrase);
  • 会话(基于存储插件);
  • 存储(扁平文件、数据库驱动);
  • 对话(链式对话);
  • 验证(基于 Respect/Validation);
  • 词干提取;
  • 插件和组件;
  • 支持 Webhooks & 简单长轮询(非异步);

🔩 安装

通过 Composer 安装

$ composer require chipslays/litegram

📁 Litegram 项目

您可以使用一个现成的、已配置好的 项目 来快速开始。

更多信息请点击 这里

1️⃣ 创建项目

composer create-project chipslays/litegram-project SuperDuperBot

2️⃣ 修改配置参数,最后在终端中输入

php lite webhook:set
php lite migration:up

🎉 恭喜,机器人项目已设置完毕。

💡 示例

require 'vendor/autoload.php';

$bot = bot($config)->webhook();

$bot->command('start', function () use ($bot) {
    $bot->ask('What is your name?', function () use ($bot) {
        $name = $bot->payload('message.text');
        $bot->reply("👋 Nice to meet you, {$name}!");
    });
});

// or
$bot->command('start', 'BotController@startConversation');

$bot->run();

注意:方法 ask 仅当 storage 驱动设置为 file 时才能正确工作。

更多示例请查看 这里

📖 文档

文档可以在 这里 找到。

🧩 VS Code 扩展

安装 Litegram Snippets 扩展来提高生产力。

🔑 许可证

在 MIT 公共许可证下发布。有关详细信息,请参阅附带的 LICENSE