TFT LP Tracker

TFT LP トラッカー

TFT LP Tracker は、進行中および完了したランク付けされた Teamfight Tactics (TFT) ゲームについてプレイヤーとその友人に警告する Discord ボットです。 /set_channelや/trackなどのコマンドを使用して、アラートを設定し、プレーヤーのパフォーマンスを追跡します。公式 Riot API を利用しています。

特徴

• リアルタイム ゲーム アラート: 登録プレイヤーがランク付けされたゲームを開始または終了したときに通知を受け取ります。

• ゲーム結果: 統計やパフォーマンスの詳細を含む、ゲーム結果の詳細な概要を受け取ります。

• 簡単なセットアップ: /set_channelでアラート チャンネルを設定し、 /trackで追跡するプレーヤーを登録します。

• Riot API を利用: 公式 Riot API を利用してゲームデータを取得します。

• 超高速: Elixir で構築され、軽量プロセスを活用して高い同時実行性とパフォーマンスを実現します。

TODO

• ➕ プレーヤーの追跡を解除する機能を追加します。

• ?各ゲーム終了時のLPの増減を含むプレイヤーのランクを表示します。

• ログ (デバッグ、情報、通知など) を再加工して、明確さと構造を改善します。

• スケーリングにとって重要なレート制限を回避するために、Riot への API リクエストを最適化します (現在、小規模コミュニティでは問題になりません)。

• ?ダブルアップモードでゲームパートナーを表示します。

• そして...リファクタリングコードベースがたくさんある(たぶん)

GitHub の問題を通じてすべての機能リクエストを歓迎します。

はじめる

前提条件

• Docker と Docker Compose

• Riot APIキー

• レディス

インストール

1. リポジトリのクローンを作成します。

    git clone https://github.com/SailorSnoW/TFT-LP-Tracker.gitcd TFT-LP-Tracker

2. 環境変数を設定します。ルート ディレクトリに.env.exampleファイルに基づいて.envを作成し、Riot API キーと Bot トークンを追加します。

    RIOT_API_KEY=your_riot_api_keyDISCORD_BOT_TOKEN=your_bot_token

3. Docker Compose で実行します。

    docker-compose up --build

   これにより、データの永続化とキャッシュのためにボットと Redis インスタンスが起動されます。

サポートされているプラ​​ットフォーム

• Riot API がサポートするプラットフォーム

使用されている技術

• Elixir : ボット開発に使用される主な言語。

• Nostrum : Discord 用の Elixir ライブラリ。

• Redix : Elixir の Redis クライアント。

• Req : Elixir の HTTP クライアント。

• Docker : ボットと Redis のコンテナ化。

ライセンス

このプロジェクトは MIT ライセンスに基づいてライセンスされています。詳細については、LICENSE ファイルを参照してください。

貢献する

貢献は大歓迎です！お気軽にプルリクエストを送信したり、問題をオープンしたりしてください。

️免責事項

このボットは現在アルファ版であり、Elixir での私の最初のプロジェクトです。コードの品質は最高ではない可能性がありますが、改善のための提案は歓迎します。

謝辞

• この LoL ボットからインスピレーションを得た: LP トラッカー

• 素晴らしいライブラリを提供してくれた Nostrum、Redix、および Req の開発者に感謝します。

• 複数の並列タスクを効率的に処理するボットの必要性に着想を得て、Elixir を選択しました。