使い方ガイド — OBS Overlay nicoChat

01

公開Botの使い方（推奨・最短手順）

インフラ構築不要で今すぐ使い始められます。以下の5ステップで設定完了します。

1

BotをDiscordサーバーに招待する

以下の招待リンクからBotをあなたのサーバーに追加してください。
「サーバーを管理する」権限が必要です。

BOT INVITE URL https://discord.com/oauth2/authorize?client_id=1484621724015399032

2

権限と対象チャンネルを設定する

サーバーオーナーまたは管理者が /config と /setup コマンドで操作権限・許可ユーザー・対象チャンネルを設定します。

            NOTE
            /setup allow_start_role や /setup allow_start_user で
            /start コマンドを使えるロール・ユーザーを追加できます。

            管理者・オーナーはデフォルトで実行可能です。
          

3

/start でセッションを開始する

表示させたいチャンネルを指定して /start を実行します。

/start channel:#コメント用チャンネル limit:100

limit は同時表示コメントの上限数です（省略可）。
実行すると DM に OBS 用 URL が送られてきます。

4

OBSのブラウザソースにURLを設定する

OBS Studio を開き、ブラウザソースを追加して DM で届いた URL を貼り付けます。

            OBS設定の目安
            ソース追加 → ブラウザ →
            URLにDMで届いたURLを設定 →
            幅・高さを配信解像度に合わせる（例: 1920 × 1080）→
            「ページが表示されなくなったときにブラウザをシャットダウン」は オフ 推奨
          

5

/auth で認証する

OBSのブラウザソースに6桁の認証コードが表示されます。そのコードを 同じサーバーのチャンネル（DMではなく）で /auth コマンドに入力して認証を完了します。

/auth code:123456

            注意
            /auth はDMでは実行できません。/start を実行したサーバーのチャンネルで行ってください。

            認証に5回連続失敗すると5分間ロックされます。
          

認証が完了すると、指定チャンネルのメッセージがOBSに流れ始めます。🎉

02

コメントのカスタマイズ（メタデータ書式）

メッセージに ?属性? を含めることで、色・サイズ・位置を指定できます。属性はメッセージのどこに書いても有効です。

書き方の例

?red ue? お知らせ
?blue big? **重要** テキスト
テキスト ?shita green?
?#ff8800 big ue? カスタムカラー

色の一覧

white

red

pink

yellow

orange

green

cyan

blue

purple

black

#RRGGBB（任意）

サイズ

値	サイズ	備考
`big`	12vh（大）	Discord の `# 見出し` でも同様
`medium`	6vh（標準）	デフォルト。`## / ###` でも同様
`small`	3vh（小）	Discord の `-# テキスト` でも同様

位置

値	効果
`ue`	画面上部に固定表示（個別タイマーで消去）
`shita`	画面下部に固定表示（個別タイマーで消去）
指定なし	横スクロール表示（ニコニコ風）

テキスト装飾（Discord書式がそのまま反映）

書式	効果
`テキスト`	太字
`テキスト`	斜体
`__テキスト__`	下線
`~~テキスト~~`	取り消し線

03

コマンドリファレンス

一般ユーザー

/help

ヘルプを表示します。

/status

CPU・メモリ・バージョン・セッション情報を表示します。

/my-status

自分のブラックリスト状態を照会します（サーバー設定が有効な場合）。

/start 許可ユーザー・管理者・オーナー

/start channel: [limit:]

指定チャンネルのコメント転送セッションを開始。OBS用URLがDMで届きます。

/auth code:

OBSに表示された6桁コードで認証します。DM不可・同サーバーのみ。

/session limit: / secret:

自分のセッション設定（コメント上限など）を変更します。

サーバーオーナー・管理者のみ

/config

/setup と /blacklist の操作権限を管理します。

/setup

/start の許可対象・拒否チャンネルなどを設定します。

/blacklist

サーバー別ブラックリストの管理・照会設定を行います。

04

よくある問題と対処法

認証コードが表示されない

OBS のブラウザソースを右クリックして「更新」を実行する
URLが正しくコピーされているか確認する
/start を実行し直してみる

/start が権限エラーになる

サーバーオーナー・管理者であるか確認する
/setup allow_start_role または /setup allow_start_user で許可されているか確認する
なお /start の許可設定は /config ではなく /setup 側です

/auth が通らない

/auth はDMではなく、/start と同じサーバーのチャンネルで実行する
5回連続失敗すると5分間ロックされるため、時間をおいて再試行する
改善しない場合は /start からやり直す

コメントが流れない・表示されない

/auth が完了しているか確認する（認証コード画面が消えていること）
Botがチャンネルを読める権限（チャンネルを見る・メッセージ履歴を読む）を持っているか確認する
ブラウザ開発者ツール（F12）のコンソールエラーを確認する

/start がコマンド一覧に出ない

グローバルコマンドの反映には最大約1時間かかる場合があります。しばらく待ってから再確認してください。

05

セルフホスト手順

公開Botで要件を満たせない場合にのみ、以下の手順でセルフホストできます。

      PREREQUISITE
      Node.js v22.0.0 以上・Discord Botアカウント・OBS Studio が必要です。
    

1. リポジトリ取得・依存インストール

git clone https://github.com/DTT-JP/Discord-to-OBS-nicoChat.git
cd Discord-to-OBS-nicoChat
npm install

2. .env 作成と設定

cp .env.example .env

最低限設定が必要な変数は以下の5つです。

変数	内容
`DISCORD_TOKEN`	Discord Developer Portal で取得したBotトークン
`CLIENT_ID`	Discord Application ID
`PORT`	HTTPサーバーの待ち受けポート（例: 3000）
`HOST`	URL生成用ホスト名（`PUBLIC_URL` 未設定時に使用）
`MASTER_KEY`	ギルド単位設定の暗号化に使う鍵素材

3. Discord Developer Portal 設定

Discord Developer Portal でアプリを作成
Application ID を CLIENT_ID に設定
Botトークンを DISCORD_TOKEN に設定
SERVER MEMBERS INTENT と MESSAGE CONTENT INTENT を有効化
OAuth2 で bot と applications.commands を付与して招待

4. スラッシュコマンド登録と起動

npm run deploy-commands   # コマンド登録（初回・変更時）
npm start                 # 本番起動
npm run dev               # 開発時（ホットリロード）

本番運用時の追加設定 本番環境では NODE_ENV=production と ALLOWED_ORIGINS（接続を許可するオリジン）の設定が必須です。 HTTPS公開については docs/https-publication.md を参照してください。

06

データとセキュリティについて

本Botはメッセージ内容を永続保存しません。 Discordメッセージは AES-256-GCM で暗号化されてリアルタイム転送されるだけで、サーバー上には残りません。

認証はワンタイムトークン（UUID v4）+ 6桁コードの2段階方式
認証コードの有効期限はデフォルト10分、5回失敗で5分ロック
認証完了後、OBS上の認証コードはDOMから除去される
セッション切断時にセッション情報は即座に削除される

詳細はプライバシーポリシーと利用規約をご覧ください。

07

お問い合わせ・バグ報告

ご質問・不具合報告は GitHub の Issue からお願いします。

CONTACT / ISSUES https://github.com/DTT-JP/Discord-to-OBS-nicoChat/issues