Add documentation for modules and runtime instructions

- Created detailed documentation for the device_manager, model, model_extra, osc, overlay, overlay_image, transcription, translation, transliteration, utils, watchdog, and websocket modules.
- Added a comprehensive run events payloads document outlining the payloads sent during various run events in the controller.
- Included runtime instructions and dependencies for setting up the project in a Windows environment.
- Introduced a mypy configuration file to manage type checking and ignore errors in specific modules temporarily.
This commit is contained in:
misyaguziya
2025-10-09 13:11:59 +09:00
parent b0fd63afbd
commit 5efa9c37d6
23 changed files with 2147 additions and 0 deletions

View File

@@ -0,0 +1,17 @@
# models/osc — 詳細設計
目的: VRChat 等と OSC / OSCQuery 経由で値の取得やチャット送信を行う。
主要クラス/関数:
- class OSCHandler
- sendMessage(message: str, notification: bool=True): OSC で chatbox/input を送信
- sendTyping(flag: bool): chatbox/typing を送信
- receiveOscParameters(): OSCQuery を立て、指定したフィルタに対してローカルでサーバを実装してイベントを受ける
- getOSCParameterValue(address: str): OSCQuery を通じて現在値を問い合わせるuse tinyoscquery
注意点:
- `is_osc_query_enabled` が True のときに OSCQuery を使う127.0.0.1 や localhost の場合に True
- 受信ハンドラは dispatcher にマップしてコールバックを呼ぶ。
- ネットワーク環境や OSCQuery の可否により動作が変わるため例外処理が多く入っている。
依存: python-osc, tinyoscquery