om

Discord.js Japan User Group向けの読み上げボットです．

使い方

まず，.env.exampleを参考に.envファイルを作成します． DISCORD_TOKEN=の後に続けて，Discord Developer Portal から取得したトークンを記述してください．

次のコマンドを実行すると，ボットが起動します（Dockerがインストールされていることが必要です）．

docker run --rm -d --env-file .env ghcr.io/discordjs-japan/om:latest

このボットを起動するには，以下のような準備が必要です．具体的な手順については，Dockerfileを参考にしてください．

.node-versionで指定されているバージョンのNode.jsをインストールする
依存関係 (node_modules) をインストールする
- Dockerfileのdepsステージに対応します．
- dependenciesをインストールすることが必要です．
ソースコードをJavaScriptにコンパイルする
- Dockerfileのbuilderステージに対応します．
- コンパイルにはdevDependenciesがインストールされていることが必要です．
読み上げ用の辞書をダウンロードする
- Dockerfileのdictionaryステージに対応します．
- ダウンロードした辞書ディレクトリのパスを起動時に環境変数DICTIONARYで指定する必要があります．
音声合成用のモデルをダウンロードする
- Dockerfileのmodelsステージに対応します．
- ダウンロードしたモデルのパスを起動時に環境変数MODELSで指定する必要があります．複数指定する場合は,で区切ってください．
ユーザー辞書をビルドする（任意）
- Dockerfileのuser-dictionaryステージに対応します．
- ビルドした辞書のパスを起動時に環境変数USER_DICTIONARYで指定する必要があります．

環境変数の一覧はこちらです：

For copyright of dependent packages, please see package.json.

[!NOTE] HTS Voice is only included in Docker container

Creative Commons Attributions 4.0

[!NOTE] naist-jdic is only included in Docker container

BSD 3-Clause License