VRChat と組み合わせるときに確かめること

VRChat と連携するツール(表情切り替えパネルなど)が動かないとき、原因が FloatSoda 側か VRChat 側かを分けられると、次に調べる箇所を絞れます。このページは、確かめる項目を VRChat 側、FloatSoda 側、つなぐ側の順に並べ、1つずつ「確かめた」と答えられるようにします。

FloatSoda 本体は OSC に依存していません。VRChat と OSC で通信するコードは、利用者が(または AI が)追加します。そのため、このページは外部ツールの使い方を書きません。VRChat の設定画面の操作、FaceEmo の使い方、OSC の通信の仕様は、それぞれの公式資料で確かめてください。通信のコードは、AI に FloatSoda を書かせるの手順で頼めます。AI が書いた API 名と設定値は、公式資料と照らしてください。

このページで確かめること

確かめる項目は、次の3つのグループに分かれます。

グループ	確かめること	項目の数
VRChat 側	OSC の有効化、パラメーター名と型、ポート	3
FloatSoda 側	SteamVR の起動、オーバーレイが出る、押せる	3
つなぐ側	送信のコードが動く、VRChat が受け取る	2(切り分けの順)

VRChat 側から確かめてください。FloatSoda 側は、VRChat が無くても確かめられますが、まとめて確かめたほうが早く終わります。

VRChat 側で確かめること

VRChat 側の項目は3つです。確かめたら、パラメーター名と型は控えて、AI に渡します。

1. OSC が有効になっている
2. アバターのパラメーター名と型が分かっている
3. ポートが分かっている

OSC は、VRChat の設定で有効にします。有効にする場所と手順は、VRChat の公式資料にあります。パラメーターは、切り替えたい表情について、名前と型(bool、int、float)を調べます。調べ方も公式資料にあります。ポートは、VRChat が OSC を受け取るポートと、送ってくるポートを確かめます。

公式資料は、VRChat Creators の OSC の概要(https://docs.vrchat.com/docs/osc-overview)から辿れます。

できた? 3つの項目のどれにも「確かめた」と答えられる。

できなかったら

公式資料を読んでも分からないときは、VRChat のコミュニティか、公式のサポートに聞いてください。どちらも FloatSoda の外にあります。

FloatSoda 側で確かめること

FloatSoda 側の項目も3つです。ツールが作成中でも確かめられます。

1. SteamVR が起動している
2. ダッシュボードにオーバーレイが出る
3. ボタンを押すと反応する

FloatSoda のアプリは、SteamVR が起動していないと動きません。ダッシュボードのオーバーレイは、SteamVR のダッシュボードを開いて、自分のツールの画面を探します。ポインタ(レーザー)で押せるのは、ダッシュボードに出ているオーバーレイだけです。ワールド座標固定や追従のオーバーレイは、押しても反応しません(追跡: #182)。

VRChat とツールは同時に動きます。ダッシュボードのボタンをポインタ(レーザー)で押す操作は、オーバーレイのマウスのイベントとして届くので、VRChat の入力とは競合しません。競合するのは、InputAction<T> で登録したコントローラーのボタンやスティックの入力です。こちらは、SteamVR のアクションセットの優先度で、どちらに届くかが決まります。

できた? 3つの項目のどれにも「確かめた」と答えられる。

できなかったら

オーバーレイが出ない、押しても反応しないときは、反応しないときに切り分けるを読んでください。押せない置き場所の制約は、リファレンスのできないこと・まだ使えないものにあります。

つながらないときの切り分け

ボタンを押しても VRChat のアバターが変わらないときは、次の順に確かめます。確かめられなかった段から、先に調べます。

1. オーバーレイは反応しているか。 ボタンを押して、画面が変わる(数字が増える、色が変わる)なら、FloatSoda 側は動いています。反応しないなら、「FloatSoda 側で確かめること」に戻ります。
2. 送信のコードは動いているか。 押したときに OSC を送るコードが実行されているかを、ログで確かめます。
3. VRChat は受け取っているか。 VRChat が OSC を受け取っているかの確かめ方は、VRChat の公式資料の OSC Debugging にあります。OSC の有効化と、送り先のポートは OSC Overview で確かめます。

コードを直すときは、確かめられなかった段と、そのときの様子を AI に伝えてください。