readme.ja.md

Free RT Bot

discordのBotであるRTのフリー版です。
RTはもともと無料で利用できましたが、有料になったためこのリポジトリが作成されました。
RTはBotが1台だけで済むように作成された多機能で便利なBotです。
ウェブ認証などのためにrt-backendとWebSocketで通信も行います。
RTについて知らない人はここを見てみましょう。
Free RTについて知らない人はここを見てみましょう。

LICENSE

BSD 4-Clause License (LICENSEファイルに詳細があります。)

Contributing

contributingをご覧ください。

Installation

Depedencies

必要なものです。

• Python 3.9以上
• MySQL または MariaDB
• requirements.txtにあるもの全て。
• rt-backendの実行 (認証等のバックエンドを必要とする機能を使う場合)

起動手順

1. 必要なものをpip install -r requirements.txtでインストールをします。
2. 必要なTOKENなどをauth.template.jsonを参考にauth.jsonに書き込む。
3. utilにrt-moduleリポジトリをそのまま(srcだけ置くとかはしないでください)置いてフォルダの名前をrt_moduleにする。
4. rt-backendリポジトリにあるプログラムを動かす。 (任意です。認証等のバックエンドを必要とするものを動かしたい場合は動かす必要があります。)
5. python3 main.py testでテストを実行する。 (この際TOKENはauth.jsonのtestのキーにあるものが使用されます。)

※ もし読み上げを動かしたいのならcogs/ttsにあるreadme.mdを読んでください。

本番環境での実行

起動コマンドはsudo -E python3 main.py productionでauth.jsonのTOKENでproductionのTOKENが必要となります。
NOTE: run.shの起動でも動きます。