alicebot

アリスボット

シンプルな Python 非同期マルチバックエンド ロボット フレームワーク

ドキュメント · ガイド · API リファレンス · 例

導入

AliceBot は、複数のプロトコル適応をサポートするシンプルな Python 非同期マルチバックエンド ロボット フレームワークであり、学習しやすく、機能を拡張するために使用しやすいプラグインを簡単に作成できます。

このプロジェクトは NoneBot プロジェクトからインスピレーションを得たものであり、比較セクションで 2 つのプロジェクトの類似点と相違点を確認して、より適切なロボット フレームワークを選択できます。

特徴

• シンプル:AliceBot は、非常に柔軟で使いやすいプラグイン作成メソッドを使用します。強力なプラグインを実装するには、2 つのメソッドを作成するだけで済みます。
• 柔軟性:AliceBot の適応プロトコルは、ライブラリやネットワーク プロトコルに束縛されません。自分に合ったアダプターを自由に選択したり作成したりできます。
• 効率的:AliceBot は Python の非同期 I/O に基づいており、大量のリクエストを簡単に処理できます。パッケージを減らし、使いやすさを維持しながら最高のパフォーマンスを追求。

現在、AliceBot は次のプロトコル適応を公式に維持しています。

• OneBot (CQHTTP) プロトコル (QQ などをサポート) ws および ws-reverse 接続方法
• OneBot v12 プロトコルの ws および ws-reverse 接続方法
• mirai-api-http プロトコル 2.0+ ws および reverse-ws 接続方法
• DingTalk Enterprise Robotの発信(コールバック)接続方法
• Telegram ロボットのポーリングと Webhook の接続方法

さらに多くのプロトコルが適応されています...

詳細情報: はじめに - AliceBot ドキュメント

今すぐ始めましょう

1. インストール：

   pip install alicebot[all]

2. 最初のアリスボットプロジェクト:

    from alicebot import Bot
   
   bot = Bot ()
   bot . load_adapters ( "alicebot.adapter.cqhttp" )
   
   bot . run ()

3. 最初のAliceBotプラグイン:

    from alicebot import Plugin
   
   
   class Echo ( Plugin ):
       async def handle ( self ) -> None :
           await self . event . reply ( self . event . message . replace ( "echo " , "" ))
   
       async def rule ( self ) -> bool :
           if self . event . adapter . name != "cqhttp" :
               return False
           if self . event . type != "message" :
               return False
           return self . event . message . startswith ( "echo " )

詳細については、AliceBot のドキュメントを参照してください。

対比

このプロジェクトは、NoneBot プロジェクトからインスピレーションを得たものです。以下に、この 2 つのプロジェクトの類似点と相違点を簡単に紹介します。

類似点:

• どちらも Python で書かれており、コルーチン非同期高性能ロボット フレームワークを使用します。
• どちらも複数のプロトコルをサポートしています。
• どちらもロボットが受信したイベントを解析して処理し、特定の機能を完了するための優先順位に従ってプラグイン (イベント レスポンダー) に配布します。
• どちらも MIT ライセンスに基づいたオープンソースであるため、ライセンスに従う限りこのプロジェクトを使用できます。

違い:

• 一般に、NoneBot はより包括的なロボット フレームワークですが、AliceBot は小さくて簡潔なロボット フレームワークであり、複雑な高度な機能は含まれていませんが、より柔軟で学習が容易です。
• 比較的言えば、AliceBot のプラグインの記述スタイルは NoneBot とは異なります。つまり、AliceBot のほとんどの機能はオプションであり、ほんの少しの知識だけで開始できます。プロジェクトのサイズと複雑さが増大しても、すぐにすべてをマスターしなくても、必要な機能を引き続きドリルダウンできます。 「これは、お客様とともに成長し、さまざまなニーズに適応できるフレームワークです。」
• NoneBot は実装の点で HTTP/WebSocket 通信プロトコルに深く結びついていますが、AliceBot はどのプロトコルにも束縛されていません。Raspberry Pi スマート スピーカーの駆動にも使用できます。 。もちろん、一般的な Web チャット ツールをサポートするボット フレームワークが必要なだけであれば、違いはありません。
• NoneBot はユーザー ベースとコミュニティの規模が比較的大きく、プラグインも多数ありますが、AliceBot は初期のプロジェクトであるため、NoneBot を使用すると、興味のあるプラグインを見つけやすくなる可能性があります。また、関連情報を見つけたり、問題が発生した場合に迅速に回答を得ることができます。

全体として、どちらにも独自の特徴があり、ニーズに応じて選択できます。

ライセンス

AliceBot は MIT ライセンスの下でオープンソースです。

このプロジェクトのアイコンは、 Misty Little Dream Godによって描かれており、このプロジェクトと同じライセンスの下で、このプロジェクトの一部として使用することができます。