メインコンテンツまでスキップ
バージョン: next

クローンして実行する

リポジトリを git でクローンして実行することができます。

必要な環境​

このボットをクローンして実行するには、以下の要件が必要です。

必須な環境​

  • Node.js (v16.16以上のv16.x、v18.x、v20.x)がサポートされていて、インストールされていること。
  • npm が利用できること。
  • ffmpeg が利用できること。
  • git が利用できること。
  • C++のビルドツールがインストールされていること。
    • ネイティブな依存関係のビルドに使用されます。
    • Windowsの場合Node.jsのインストール時に、node-gypのビルドツールをインストールするかを聞かれます。
      • もしこれをしないでインストールした場合には、npm i -g windows-build-toolsを実行するとよいようです。
    • Unix系の場合、そのOSのビルドツールを一発でインストールできる場合があります。
      • Ubuntuの場合、apt install build-essentialでできます。
      • CentOSの場合、yum groupinstall "Development Tools"でできます。
メモ
  • ffmpegは、インストール時にnpmが自動的にダウンロードするため、事前にダウンロードしたり、パスを通したりする必要はありませんが、一部の環境ではこれが利用できない場合があります。その際には、後述の手順で、npm installしたときに、その旨の表示がされます。この場合、自分で別途ffmpegをインストールする必要があります。
  • 手動でインストールする場合、一部のffmpegのバージョンは対応していない可能性があるため、最新版を推奨します。
  • npmでffmpeg-staticが利用できる場合、そちらを優先して使用します。

推奨事項​

これらの事項は、満たしていないと動作しない恐れがある項目です。できる限り満たしておくようにしてください。

  • Python 2.x または 3.x のバージョンがインストールされていること。
  • Unix系の環境であれば、nscdがインストールされ、サービスが稼働していること。
メモ

nscdは、apt等のパッケージマネージャーでインストールできます

注意​

  • Cloudflare WARP などが設定されているとうまく動かないことがあるみたいなので、動作しないようであれば設定を解除してください。
  • ボットを実行するユーザーに、ボットを配置するフォルダ(ディレクトリ)の書き込み権限を与えてください。読み取り専用の状態では、一部のボットの機能が正しく動作しない恐れがあります。

設定の手順​

1. クローン​

インストールしたいディレクトリへ移動し以下を実行します

# リポジトリをクローン
git clone https://github.com/mtripg6666tdr/Discord-SimpleMusicBot.git
# カレントディレクトリ移動
cd Discord-SimpleMusicBot

masterブランチは開発用のブランチでもあり、未修正のバグが含まれている可能性があるため、最新のバージョンを指定することをお勧めします。 例えば、v3.4.0を使用する場合、以下のようにします。

git reset --hard v3.4.0

以下のコマンドで、依存関係のパッケージをインストールします。

# 必須パッケージインストール
npm install

2. ボットの設定​

ボットを実行するには、ボットのトークンを含む各種設定が必要です。「ボットの設定について」を参考に、設定を行ってください。.envファイルやconfig.jsonファイルは、package.jsonと同じフォルダに配置します。

3. トランスパイル＆実行​

以下のコマンドを実行します。

# トランスパイル
npm run build
# 実行
npm run onlystart
Tips

トランスパイルと実行は一括して次のコマンドで行うこともできます。

npm run start

次回から起動する際は、npm run onlystartだけで起動することができます。

なお、スラッシュコマンドは、起動時に自動的に追加されるようになりました。スラッシュコマンドについての詳細は、あとのページで解説しています。

コードの更新​

警告

v3からv4の更新の際に、config.jsonでの設定内容が追加されています。 追加しないと起動しないようになっていますので、必ずドキュメントサイトやconfig.json.sampleを参照の上更新してください。

本ボットを最新のソースコードに更新するには、以下のような操作を行ってください。

# ソースコードの更新
git fetch
git reset --hard <最新のバージョン>
# 依存関係の更新
npm install
# トランスパイル
npm run build
# 実行
npm run onlystart
Tips

トランスパイルと実行は一括して次のコマンドで行うこともできます。

npm run start
新しいビルドスクリプトを使用する(ベータ版・v4.3以降)

v4.3以降では、このページで紹介しているnpm run buildによるビルドに加え、 新しいビルドスクリプトを導入しています。
※Dockerイメージのビルド時にはこちらが使用されています。

ベータ版ですが、出力されるファイル数が少なくなり、パフォーマンスが向上するため、 ぜひお試しください。

新しいビルドスクリプトは、npm run buildの代わりに、

npm run build:bundled

を実行することでご利用いただけます。

それ以外の手順やコマンドは同じとなります。