Skip to content

Latest commit

 

History

History
75 lines (54 loc) · 3.39 KB

README.md

File metadata and controls

75 lines (54 loc) · 3.39 KB

om

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

使い方

Dockerfileで定義したイメージを使う

まず,.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で指定する必要があります.

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

  • DICTIONARY:読み上げ用の辞書ディレクトリのパス
    • 必ず指定してください.
  • USER_DICTIONARY:ビルドしたユーザー辞書のパス
    • 指定しなくても動作します.
  • MODELS:音声合成用のモデルのパス
    • 必ず指定してください.
    • 複数指定する場合は,で区切ってください.
  • DISCORD_TOKEN:Discord Developer Portalから取得したトークン
    • 必ず指定してください.

Copyright Notice

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

Note

HTS Voice is only included in Docker container

Creative Commons Attributions 4.0

  • Copyright (c) 2015 Intelligent Communication Network (Ito-Nose) Laboratory, Tohoku University.

Note

naist-jdic is only included in Docker container

BSD 3-Clause License

  • Copyright (c) 2009, Nara Institute of Science and Technology, Japan.
  • Copyright (c) 2011-2017, The UniDic Consortium
  • Copyright (c) 2008-2016 Nagoya Institute of Technology Department of Computer Science
  • Copyright (c) 2023, JPreprocess Team