VRChat Recorder is a tool for recording VRChat Videos, Audios, OSC Feedbacks, and Controller inputs.
- Python 3.10+
- OBS Studio Enable Websocket Server in OBS Studio.
- VRChat Enable OSC.
Clone this repository and install it.
git clone "<URL>"
cd vrchat-recorder
pip install -e .python -m vrchat_recorder -d <directory> `
--mic "Mic Device Name" `
--speaker "Headphone Device Name" `
# --no_gamepad ` # If you don't want to record gamepad info.
# --no_obs ` # If you don't want to record by OBS.
# --no_osc_feedback ` # If you don't want to record OSC feedback.
# --no_mic ` # If you don't want to record mic.
# --no_speaker ` # If you don't want to record speaker.
# --no_vr ` # If you don't want to record VR info.このコマンドで記録を開始することができます。Ctrl+Cで停止できます。
スクリプトファイルとして起動する場合はデモプログラムを参照してください。
記録されたデータは<directory>/<YYYY-MM-DD-hh-mm-ss-millisec>.vrcrecディレクトリに保存されます。通常はOBSの起動やVRChatのOSCの有効化を確認するためのメッセージが表示されます。
-
プレイ動画・音声
OBS Studioによって録画されます。事前にOBS Studioを起動し、VRChatの画面が録画されるように設定しておいてください。
録画はpythonによって自動的に開始され、記録された動画は
.vrcrec/<YYYY-MM-DD-hh-mm-ss-millisec>.video.<ext>に保存されます。このファイルはOBS Studioで設定された保存場所から移動されてるため、記録中に.vrcrecに動画ファイルは存在しません。 ファイル名に含まれる時刻はディレクトリの時刻と少しずれます。また、<ext>はOBS Studioで設定されたファイル形式です。 -
OSC フィードバックデータ
VRChatによって送信されたOSCメッセージをCSV形式で記録します。デフォルトでは
avatar/parameters/以下のメッセージのみ記録されます。 ファイルは.vrcrec/<YYYY-MM-DD-hh-mm-ss-millisec>.oscfb.csvに保存されます。ファイル名に含まれる時刻はディレクトリの時刻と少しだけずれる事があります。フォーマットは次のようなCSVです。
timestamp,event_type,parameter_name,data_type,value 1679657265.7147608,/avatar/parameters/AngularY,float,8.0 -
ゲームパッドの入力データ
ゲームパッドの入力データをCSV形式で記録します。 ファイルは
.vrcrec/<YYYY-MM-DD-hh-mm-ss-millisec>.<gamepad name>.gamepad.csvに保存されます。ファイル名に含まれる時刻はディレクトリの時刻と少しだけずれる事があります。フォーマットは次のようなCSVです。
timestamp,parameter_name,data_type,value 1679657265.7147608,ABS_X,int,128 -
Mic / Speakerの音声データ
Mic / Speakerの音声データをWAV形式で記録します。 ファイルは
.vrcrec/audio/<YYYY-MM-DD-hh-mm-ss-millisec>.<mic or speaker>.wavに保存されます。ファイル名に含まれる時刻はディレクトリの時刻と少しだけずれる事があります。 -
VR Deviceの入力データ
HMDの姿勢やコントローラの入力データを保存します。
.vrcrec/vrディレクトリの中に記録されます。 コントローラーのボタンイベントは<YYYY-MM-DD-hh-mm-ss-millisec>.event.ctrlr.csvに保存されます。フォーマットは次のようなCSVです。
event_typeやcontroller_role,buttun_idの割り当てはOpenVRを参照願います。timestamp,event_type,controller_role,button_id,age_seconds 1681472097.320673,202,1,33,13.319028854370117姿勢やトリガーの押し込み具合といった逐次データは
<YYYY-MM-DD-hh-mm-ss-millisec>.tracking.binに保存されます。 このファイルはバイナリファイルで、1フレームのデータ構造はtracking_data_holders.pyのVRDeviceTrackingDataHolderを参照してください。バイナリファイルの読み出しは
vrchat_recorder.vr.TrackingReaderを使用してください。 詳しくはトラッキングデータの記録と読み出しのデモコードを参照してください
-
-d <directory>,--output-dir <directory>: 記録データを保存するディレクトリを指定します。デフォルトではカレントディレクトリです。 -
--no-ask: 記録開始時にOBSの起動やOSCの有効化を確認するかどうかを指定します。デフォルトでは確認します。 -
--date_format <format>: ディレクトリ名に含まれる日付のフォーマットを指定します。デフォルトでは%Y-%m-%d-%H-%M-%S-%fです。 -
--log_level <level>: ログレベルを指定します。デフォルトではINFOです。
-
--vrchat_osc_ip <ip>: VRChatのOSCを受信するIPアドレスを指定します。デフォルトではlocalhostです。 -
--vrchat_osc_port <port>: VRChatのOSCを受信するポート番号を指定します。デフォルトでは9001です。 -
--vrchat_osc_address <address>: VRChatの受信するOSCアドレスを指定します。デフォルトでは/avatar/parameters/*です。
-
--obs_websocket_ip <ip>: OBS StudioのWebsocketを受信するIPアドレスを指定します。デフォルトではlocalhostです。 -
--obs_websocket_port <port>: OBS StudioのWebsocketを受信するポート番号を指定します。デフォルトでは4444です。 -
--obs_websocket_password <password>: OBS StudioのWebsocketのパスワードを指定します。WebSocketServerの認証設定をしていない場合は指定する必要はありません。
-
--mic_device_name <name>,--mic <name>: 録音するマイクのデバイス名を指定します。デフォルトではシステムデフォルトのマイクを使用します。 -
mic_sample_rate <rate>: 録音するマイクのサンプリングレートを指定します。デフォルトでは44100です。 -
--mic_channels <channels>: 録音するマイクのチャンネル数を指定します。デフォルトでは1です。 -
--mic_block_size <size>: 録音するマイクのブロック(チャンク)サイズを指定します。デフォルトでは4096です。 -
--mic_flush_interval <interval>: ファイルへ一度にフラッシュするブロックの数です。デフォルトでは100です。 -
--mic_subtype <subtype>: 録音する音声ファイルのサブタイプを指定します。デフォルトではPCM_16です。
-
--speaker_device_name <name>,--speaker <name>: 録音するスピーカーのデバイス名を指定します。デフォルトではシステムデフォルトのスピーカーを使用します。 -
--speaker_sample_rate <rate>: 録音するスピーカーのサンプリングレートを指定します。デフォルトでは44100です。 -
--speaker_channels <channels>: 録音するスピーカーのチャンネル数を指定します。デフォルトでは2です。 -
--speaker_block_size <size>: 録音するスピーカーのブロック(チャンク)サイズを指定します。デフォルトでは4096です -
--speaker_flush_interval <interval>: ファイルへ一度にフラッシュするブロックの数です。デフォルトでは100です。 -
--speaker_subtype <subtype>: 録音する音声ファイルのサブタイプを指定します。デフォルトではPCM_16です。
-
--vr_tracking_fps <fps>: VRトラッキング情報を記録するFPSを指定します。デフォルトでは72.0です。 -
--vr_tracking_flush_interval <interval>: VRトラッキング情報を記録する際のファイルへのフラッシュ間隔(frame数)を指定します。デフォルトでは100です。 -
--vr_controller_event_poll_interval <interval>: VRコントローラーのイベントを記録する際のポーリング間隔(seconds)を指定します。デフォルトでは0.001です。 -
--vr_controller_event_flush_interval_seconds <seconds>: VRコントローラーのイベントを記録する際のファイルへのフラッシュ間隔(seconds)を指定します。デフォルトでは10.0です。
-
--no_osc_feedback: OSCフィードバックを記録しない場合は指定します。デフォルトでは記録します。 -
--no_gamepad: ゲームパッドの入力を記録しない場合は指定します。デフォルトでは記録します。 -
--no_obs: OBSを用いてプレイ映像および音声を録画しない場合は指定します。デフォルトでは記録します。 -
--no_mic: マイクを用いて音声を録音しない場合は指定します。デフォルトでは記録します。 -
--no_speaker: スピーカーを用いて音声を録音しない場合は指定します。デフォルトでは記録します。 -
--no_vr: VRトラッキング情報やVRコントローラーのイベントを記録しない場合は指定します。デフォルトでは記録します。
- マウスやヘッドセットの操作情報にも対応する。
- マウスとキーボードによる操作記録機能の実装。
- VRヘッドセットとコントローラによる操作記録機能の実装
- HMDに映っているいる映像も記録できるようにする。
MIT.