Node.jsアプリ連携
ゆかコネNEO v3.0 のドキュメントです。このプラグインは v3.0 で新しく入ったもの（ゆかコネNEO v3.0.0 beta 30 から、プラグインの版は v1.0）で、v2.3 にはありません。v2.3 との違いは v2.3 から v3.0 への移行 をご覧ください。
前提条件
- 初めて使うときに、Node.js（約 30MB）を nodejs.org から自動で入れます。そのときだけインターネットにつながっている必要があります
- Node.js を自分で入れておく必要はありません。すでに入っていても、それとは別に動きます
このプラグインで出来ること¶
Node.js で作られた、字幕の表示などのアプリ（有志の方が配っているもの）を、ゆかコネNEO と一緒に動かします。
- 黒い画面（コマンドプロンプト）を開いておく必要がなくなります。アプリは画面に出ずに動きます
- ゆかコネNEO を起動するとアプリも起動し、ゆかコネNEO を閉じるとアプリも終わります（ゆかコネNEO が落ちたときも、アプリが残りません）。「OBS より先にアプリを起動する」といった順番を気にしなくてよくなります
- アプリごとに Node.js を持つ必要がなくなります。Node.js は この PC に 1 つだけ入れて、すべてのアプリで使います
- OBS に貼る URL を画面からコピーできます
- 「ポート 3000 が使われている」ときは、起動せずにどのアプリが使っているかを画面に出します
- アプリが出した文字（ログ）を画面で見られます。うまく動かないときに作者へ見せられます
しくみ
アプリは、アプリの作者が配っている zip（またはそれを展開したフォルダ）から入れます。
作者が zip に node フォルダ（node.exe）を同梱していても、それは使わずに省きます。
アプリを作る方向けの説明は Node.js アプリの配り方 にあります。
信頼できる作者のアプリだけを入れてください
アプリは、この PC の中で自由に動くプログラムです。入れる前に、作者・起動するファイル・使うポートを確かめる画面が出ます。
有効化¶
プラグイン一覧で Node.js アプリ連携プラグイン の「プラグインを使う」チェックを ON にしてください。手順は プラグインの有効化 をご覧ください。
「使う」にすると、「ゆかコネNEO と一緒に起動する」が入っているアプリが起動します。 初めてのときは Node.js を入れるので、数十秒かかることがあります。
動いているかの確かめ方¶
設定画面を開かなくても、プラグイン一覧のこのプラグインの行（と上のツールバー・ホームのランプ）の丸の色と言葉で分かります。
| 丸 | 意味 |
|---|---|
| 緑（正常） | 入っているアプリがすべて動いています |
| 青（動作中） | Node.js を入れているところか、アプリが起動の途中です（起動に 10 秒ほどかかるアプリもあります） |
| 黄（注意） | アプリが止まったので、自動で起動し直しています |
| 赤（エラー） | 起動できないアプリがあります。設定を開くと「はじめに」の先頭に、アプリと理由が出ます |
| 灰（停止） | 動いているアプリがありません |
起動した・止まった・起動できなかった（とその理由）は、ステータスの一覧にも 1 行ずつ残ります。
設定¶
プラグイン一覧で、このプラグインの名前の右にある 「設定」 を押すと開きます。 左の一覧に 「はじめに」 と、入れたアプリが 1 本ずつ並びます。
はじめに¶
いちばん上には、起動できないアプリがあるときだけ「⚠ うまく動いていないアプリがあります。」と、アプリごとの理由が出ます。
アプリを追加
| 項目 | 説明 |
|---|---|
| 「zip から追加」ボタン | 作者から受け取った zip を選びます。中身（作者・版・起動するファイル・使うポート・大きさ）を確かめる画面が出て、OK を押すと入れます。 |
| 「フォルダから追加」ボタン | zip を展開したフォルダを選びます。展開してできた 1 つ上のフォルダ（アプリ名-v1.0 のような名前のもの）を選んでもかまいません。 |
入れ終わると、左の一覧にそのアプリが加わり、そのアプリのページが開きます（設定画面を開き直す必要はありません）。 このプラグインを「使う」にしていて、アプリが「ゆかコネNEO と一緒に起動する」になっていれば、そのまま起動します。
同じアプリをもう一度入れると、前の版は _backup フォルダへ残します。
style.css や config.json を書き換えて使っていた場合は、入れ直したあとで _backup から戻してください。
入っているアプリ
入れたアプリと、いまの様子（動いています／止まっています／動いていません: 理由）が並びます。
Node.js
| 項目 | 説明 |
|---|---|
| 「Node.js を入れる」ボタン | Node.js をいま入れます。ふつうは押さなくても、アプリを起動するときに自動で入れます。 |
| 「zip から Node.js を入れる」ボタン | 会場の回線などで自動で入れられなかったときに使います。画面に出ている URL の zip を別の PC で落として選びます。公式のものと一致しない zip は入れません。 |
| 「アプリの置き場を開く」ボタン | アプリを入れたフォルダをエクスプローラーで開きます。 |
アプリのページ¶
左の一覧でアプリを選ぶと開きます。
OBS に貼る URL
アプリが用意している URL ごとに「○○ をコピー」と「○○ をブラウザで開く」のボタンが並びます。コピーした URL を OBS の「ブラウザ」ソースに貼ります。
OBS に貼る前に「ブラウザで開く」で、字幕が出るかを確かめられます（背景が透明なアプリは、ブラウザでは白く見えることがあります）。
アプリが URL を用意していない場合は、アプリが起動したときにログに出した URL（http://localhost:3000 など）が出て、「知らせた URL をコピー」「知らせた URL をブラウザで開く」で使えます。
OBS のブラウザソースは
「シーンがアクティブになったときにブラウザの表示を更新」を入にしておくと確実です。
動かす
| 項目 | 説明 |
|---|---|
| いまの様子 | 動いています（PID）／起動しています…（ポートで待ち受けるのを待っています）／止まっています／動いていません（理由）が出ます。 |
| 「起動」「停止」「再起動」ボタン | アプリを起動・停止します。 |
| ☑ ゆかコネNEO と一緒に起動する | 入れると、ゆかコネNEO を起動したときにこのアプリも起動します。（既定：アプリの作者が決めた値。ふつうは ON） |
アプリが途中で止まったときは、少し間をあけて自動で起動し直します。起動してすぐに止まるのが 5 回続いたときは、起動し直すのをやめて「動いていません」と出します。
配信ソフト向けテキスト出力との連携
アプリが 配信ソフト向けテキスト出力 の書き出すファイルを読む場合だけ出ます。 出ているフォルダを、配信ソフト向けテキスト出力の 「書き出し先のフォルダ」 に指定してください。「書き出し先のパスをコピー」で写せます。
ログ
アプリが出した文字の最後の数行が出ます。「ログファイルを開く」で全体（ync-app.log）を開けます。
このアプリを外す
アプリを止めて一覧から外します。ファイルは消さずに _backup フォルダへ移します。外し終わると左の一覧から消え、「はじめに」に戻ります。
使うとき¶
字幕を OBS に出すアプリ（配信ソフト向けテキスト出力の書き出すファイルを読んで、ブラウザソースに表示するもの）を例にします。
- このプラグインを「使う」にします。
- 設定の「はじめに」で 「zip から追加」（展開済みなら 「フォルダから追加」）を押し、作者から受け取ったものを選びます。
中身を確かめる画面が出たら OK を押します（同梱の
nodeフォルダは省かれます）。 - 入れ終わると、そのアプリのページが開き、アプリが起動します。「いまの様子」が「動いています」になるまで待ちます （「起動しています…」の間は起動の途中です）。
- アプリが 配信ソフト向けテキスト出力 を使う場合は、このページに出ているフォルダを、 配信ソフト向けテキスト出力の「書き出し先のフォルダ」に指定します。
- 「OBS に貼る URL」のボタンで URL をコピーし、OBS のブラウザソースに貼ります。
次からはゆかコネNEO を起動するだけで、アプリも起動します。
アプリの説明書に書いてあることのうち、要らなくなるもの
- アプリを起動するための
.batなどを起動すること、黒い画面を開いたままにすること - OBS より先にアプリを起動すること
- ポートが使われているかを
netstatで調べること（このプラグインが画面に出します） - Node.js を別に入れること
カスタマイズ（CSS や設定ファイルの書き換え）は、アプリの説明書のとおりにできます。ファイルは「アプリのフォルダを開く」で開いた場所にあります。
アプリの説明書で指定されたフォルダ名（public など）は、この場所の中にあります。
困ったとき¶
アプリのページの「いまの様子」と「ログ」に理由が出ます。
| 出る文言 | 確かめること |
|---|---|
| Node.js を取れませんでした | インターネットにつながっているか。つながらない場所では「zip から Node.js を入れる」を使います。 |
| ポート 3000 を ○○ (PID …) が使っています | 出ているアプリを閉じます。同じアプリを 2 つ起動していないか（アプリの .bat などを別に起動したままになっていないか）も確かめます。 |
| 起動するファイル ○○ が見つかりません | 入れ直してください。フォルダを選ぶときは、アプリの入ったフォルダかその 1 つ上を選びます。 |
| 起動してすぐに終わるのが 5 回続いたので止めました | ログを確かめ、作者に見せてください。 |
| ○○ は Node.js ○○ を求めていますが… | アプリがこのプラグインの Node.js より新しい版を求めています。ゆかコネNEO の更新を待つか、作者に相談してください。 |
置き場
| もの | 場所 |
|---|---|
| アプリ | %APPDATA%\YukarinetteConnector\NodeApps\<アプリのID>\ |
| 入れ替え前の版・外したアプリ | %APPDATA%\YukarinetteConnector\NodeApps\_backup\ |
| Node.js | %LOCALAPPDATA%\YukarinetteConnector\NodeRuntime\ |
そのほか
- アプリの使い方やカスタマイズは、アプリの作者の案内に従ってください
- アプリを作る方は Node.js アプリの配り方 をご覧ください。node.exe を同梱せずに配れ、字幕を WebSocket で直接受け取ることもできます