setup-resonite-env

name	setup-resonite-env
description	Use when setting up the resonite-io dev environment on a fresh clone, configuring Gale profile, setting Steam Launch Options (WINEDLLOVERRIDES), or troubleshooting mod-load failures. Triggers: 'just init', 'Gale プロファイル', 'WINEDLLOVERRIDES', 'check-gale', 'mod が読まれない', '環境構築', 'fresh clone'.
version	0.1.0

Setup Resonite-IO Dev Environment

resonite-io をホストで動かすために必要な準備の一覧と落とし穴の解説。ホスト側で必要なものは docker / docker compose v2 / just に加えて devcontainer を開く手段 (VS Code の Dev Containers 拡張 / Zed / @devcontainers/cli) のいずれか。.NET / uv / protoc / pre-commit はすべてコンテナ内に閉じている。

---

1. Docker 開発環境

開発ツール (.NET 10 SDK / uv / protoc / dotnet local tools / pre-commit) は debian:13-slim (trixie) ベースの単一 image に同梱し、host にはインストールしない。同 image には devcontainer 内で Resonite を起動するための X11 / GPU ユーザースペース / audio / umu-launcher (Proton) も同梱する。

• compose.yml は .devcontainer/compose.yml に置き (name: resonite-io)、.devcontainer/devcontainer.json がこれを参照する。build context も .devcontainer/
• GPU 固有設定 (runtime: nvidia / devices / Mesa 環境変数等) は .devcontainer/compose.{nvidia,amd,intel}.yml overlay に分離し、initialize.sh が host GPU ベンダを検出して .devcontainer/compose.gpu.yml symlink を貼る (NVIDIA / AMD / Intel 対応。NVIDIA はドライバを nvidia-container-toolkit が inject、AMD は Mesa RADV / Intel は Mesa ANV を build-arg GPU で image に同梱)
• 作業ディレクトリは host repo を /workspace に直接 rw bind。host 側の編集が即座に container 側に反映され、container 内の build 成果物 (bin/, obj/, python/.venv/ 等) も .gitignore 経由で host 側に出る
• Resonite フォルダは /resonite に read-only bind のみ (FrooxEngine.dll 等の HintPath 参照用、かつ container 内 Resonite 起動時の rsync source。mod の deploy 先ではない)
• Resonite 用 named volume: resonite-app (/opt/resonite インストールコピー) / resonite-share (~/.local/share、SteamRT/Proton + ユーザーデータ) / resonite-cache (~/.cache) / resonite-prefix (~/prefix、Wine prefix)
• Gale プロファイル (./gale/) は /workspace/gale 経由で参照する (environment.GalePath: /workspace/gale が csproj の deploy 先を解決)
• コンテナ内 dev user の UID/GID を host user に一致 させて build (HOST_UID / HOST_GID を build-arg で渡す)。これにより deploy-mod で出力された DLL/PDB が host user 所有になり、host 側 git からそのまま見える
• NuGet / uv のキャッシュは named volume にマウントして再ビルドを高速化 (/home/dev/.nuget / /home/dev/.cache/uv)
• csharpier / tcli 等の .NET CLI ツールは .config/dotnet-tools.json の local tool として固定し、dotnet tool restore + dotnet <tool> で呼び出す

初回 setup フロー:

1. .env.example を .env にコピーし、ResonitePath を Resonite 実行ファイルディレクトリ絶対パスに設定 (container 内 Resonite 起動では /resonite:ro bind の source として再利用される)
2. just init を host 側で実行 — docker / docker compose v2 検出 → .env 検証 → ResonitePath 検証 → Gale プロファイル確認を冪等に実施
3. devcontainer を開く — VS Code: 「Dev Containers: Reopen in Container」、Zed: dev container として開く、CLI (任意・headless / CI 用): devcontainer up --workspace-folder . → devcontainer exec --workspace-folder . bash (@devcontainers/cli、既定では未インストール)
4. devcontainer が自動実行する:
   • initializeCommand (host 側・作成前、.devcontainer/initialize.sh): host UID/GID を .env に記録 (build-arg でコンテナ user に一致させ、deploy 成果物が host 所有になる)。加えて container 内 Resonite 起動のために AppArmor の非特権 user namespace 制限を hard fail チェック (§6 参照)、DISPLAY / X auth cookie (FamilyWild 書換えで .xauth) / render・video GID / GPU ベンダを検出して .env に記録し、compose.gpu.yml symlink を貼る。本番 gRPC UDS dir は host 側に作らない — Resonite は container 内で起動し、mod (GrpcHost) が container 内 ~/.resonite-io/ を bind 前に自分で mkdir する
   • postCreateCommand (container 内・作成後): scripts/container-init.sh を実行 (deps 解決: dotnet tool restore + uv sync + pre-commit install + Codex settings symlink)
5. 以降はコンテナ内ターミナルで just gen-proto / just build / just deploy-mod 等を従来どおり実行する。devcontainer 内で Resonite を起動する場合は just resonite-launch --vanilla (mod なし) / just resonite-launch (mod 込み) (§5)

---

2. Gale プロファイル方式

ホスト Resonite には BepisLoader を直接インストールしない (Vanilla 維持)。代わりに Gale (v1.5.4+) のカスタムプロファイル機能で repo root の ./gale/ を mod sandbox にする。

手動セットアップ手順:

1. Gale で profile を新規作成し、パスを <repo>/gale に指定 (指定先は EMPTY である必要があり、./gale/ を事前に作らない)
2. profile に必須 mod を投入する:
   • 推奨: 作成した profile を選択した状態で Import > ... profile from file を選び、<repo>/GaleProfile.r2z (必須 mod を版指定込みで含む repo 同梱の profile snapshot) を選んで profile を overwrite する。これで必須 mod 一式が一括で投入される
   • フォールバック (手動): snapshot が mod 更新に追従して古くなった場合等は、以下 6 個を個別に install する:
     • ResoniteModding-BepisLoader (>=1.5.1)
     • ResoniteModding-BepInExResoniteShim (>=0.9.3)
     • ResoniteModding-BepisResoniteWrapper (>=1.0.2)
     • ResoniteModding-BepInExRenderer (>=5.4) ← Camera v2 で追加 (Renderer 側 BepInEx 5 framework、Renderer/BepInEx/core/ に framework deploy)
     • ResoniteModding-RenderiteHook (>=1.1.1) ← Camera v2 で追加 (engine → Renderer doorstop inject)
     • Nytra-InterprocessLib (>=3.0.0) ← Camera v2 で追加 (engine ↔ Renderer shared-mem queue)
   • GaleProfile.r2z はあくまで利便のための snapshot であり、必須部品の正本は just check-gale (下記 step 4)
3. Gale で Resonite を起動すると LinuxBootstrap.sh がプロファイル版に差し替わり、BepInEx が有効化される
4. just check-gale (または just init) で必須 DLL の在中を検証
5. just deploy-mod で gale/BepInEx/plugins/ResoniteIO/ に DLL+PDB が配置される (deploy 先 dir は csproj の <Copy> が自動 mkdir する)

just check-gale は BepInExRenderer 検出時に Renderer/BepInEx/core/BepInEx.Preloader.dll の存在で判定する (plugin dir ではなく framework dir に deploy するため。feedback_bepinex_renderer_as_framework.md 参照)。

Camera v2 Renderer plugin (committed prebuilt)

Camera v2 の Renderer 側 plugin (ResoniteIO.Renderer、net472 Unity Mono、BepInEx 5) は、ローカル build 時に Renderer.csproj の DeployRendererPlugin が gale/Renderer/BepInEx/plugins/ResoniteIO.Renderer/ へ DLL を deploy する (engine 側 gale/BepInEx/plugins/ResoniteIO/ とは別系統)。

UnityEngine.CoreModule が非再配布で CI build 不可のため、配布物 (Thunderstore zip) には committed prebuilt mod/prebuilt/renderer/ を同梱する (release-resonite skill §7 参照)。Renderer のソース (mod/src/ResoniteIO.Renderer/ ∥ mod/src/ResoniteIO.RendererShared/) を変更したら、Resonite のあるローカルで just renderer-prebuild を実行し mod/prebuilt/ の差分を commit する。忘れると just run 末尾の check-renderer-prebuilt (および CI の drift guard) が fail する。

ホスト Resonite を Vanilla で起動 (Gale を介さず Steam から直接起動) した場合は mod は読み込まれない。注意: Gale 経由起動後にホスト Resonite ディレクトリへ hookfxr.ini (enable=true) 等が残る場合がある。Vanilla 復帰時は確認すること。

---

3. WINEDLLOVERRIDES (両経路で必須 — container は自動 export、host Steam は手動)

Camera v2 の Renderer 側 BepInEx を起動させる doorstop は hook 版 winhttp.dll プロキシで、Wine に system 同梱でなく hook 版 winhttp.dll を読ませるには どちらの起動経路でも WINEDLLOVERRIDES="winhttp=n,b" が必要 (2026-06-19 実機検証)。--doorstop-* の CLI 引数は doorstop の 挙動 を設定するだけで、winhttp.dll の 読み込み自体 はこの override が前提。経路で違うのは「誰が override を設定するか」だけ:

• container 内 just resonite-launch 経路: resoio launch (python/src/resoio/launcher.py) が mod 起動時に WINEDLLOVERRIDES="winhttp=n,b" を自動で export するため 利用者の手動設定は不要。umu-run は Steam と違い env を素通しするので env 経由で渡せる
• host Steam 経由起動の場合: Steam で Resonite を選択 → Properties → Launch Options に以下を設定する:

WINEDLLOVERRIDES="winhttp=n,b" %command%

• なぜ必須: Wine は system 同梱 winhttp.dll を優先するため、RenderiteHook が deploy した hook 版 winhttp.dll (= doorstop) を読ませるには override が必要。これが無いと Renderer 側 BepInEx は永遠に起動せず、Camera v2 の renderer-side plugin が load されない
• debug が困難: 真の原因が override 漏れであることは /proc/<pid>/environ で確認できないと見抜けない (Wine プロセスの env を host から見るのが面倒)
• host Steam では Launch Options が唯一の経路: env で WINEDLLOVERRIDES を渡しても Steam が sanitize するため通らない。umu-run は素通しなので container では resoio launch が env で渡せる、という違い

---

4. UDS パスと pressure-vessel sandbox

• 本番 gRPC IPC は $HOME/.resonite-io/。Resonite を container 内で起動するため host とは共有せず、container 内 /home/dev/.resonite-io/ に mod (GrpcHost) が socket を作り、同 container 内の Python client がそこへ connect する
• $XDG_RUNTIME_DIR/ (= /run/user/<UID>/) は pressure-vessel sandbox が通さないため不採用
• /tmp/ も通らない。$HOME/ 配下のみが安全
• 詳細は reference_pressure_vessel_paths.md

---

5. devcontainer 内で Resonite を起動 (just resonite-launch)

devcontainer 内で Resonite を直接起動できる。ro bind の /resonite から書込可能な /opt/resonite への rsync は .devcontainer/entrypoint.sh が container 起動時に行う (初回は install コピー、2 回目以降は差分のみ)。resoio launch (python/src/resoio/launcher.py) が umu-run (umu-launcher/Proton) で RESONITE_EXE (= /opt/resonite/Resonite.exe) を起動する。初回は GE-Proton の DL でも時間がかかる。

起動・停止は以下:

• just resonite-launch (= resoio launch): MOD_PATH の Gale プロファイル (./gale = /workspace/gale) から mod 込みで起動する。engine 側は hookfxr、Renderer 側は doorstop (hook 版 winhttp.dll)。resoio launch が WINEDLLOVERRIDES="winhttp=n,b" を自動 export するため Steam Launch Options の手動設定は不要 (§3)。./gale/BepInEx が無ければ fail-fast (先に just deploy-mod)。engine (native の dotnet プロセス) と renderer (Renderite.Renderer.exe) の両プロセスが現れるまで待ってから両 host PID を返す。既に起動中なら error (single-instance)
• just resonite-launch --vanilla: mod を読まない素の Resonite を起動 (起動確認・切り分け用)
• just resonite-stop (= resoio terminate): engine + renderer を psutil 経由で SIGTERM → 3s → SIGKILL の段階 kill。engine の実体は dotnet プロセスで、Resonite.exe 名のプロセスは wine ブートストラップにすぎない
• 起動状態の確認は pgrep -af Renderite.Renderer.exe (renderer プロセスの有無で判定)

just resonite-launch で起動した mod のログは gale/BepInEx/LogOutput.log (just log で tail)、umu/Proton の起動ノイズは gale/BepInEx/umu-launch.log に分離される。

前提 (host 側)

• graphical session (X11 / Xwayland): Resonite の描画に必要。initialize.sh が DISPLAY を検出し、X auth cookie を FamilyWild (ffff) 書換えで .xauth に用意する (container hostname がランダムで MIT-MAGIC-COOKIE の hostname マッチに失敗するため)
• PipeWire/PulseAudio: 音声に必要 (無いと初回オンボーディングで固まることがある)
• AppArmor 緩和: kernel.apparmor_restrict_unprivileged_userns=0 が必須 (§6 参照)
• GPU: NVIDIA / AMD / Intel いずれも対応。initialize.sh がベンダを検出して compose overlay を切替える

.env 変数 (通常は手動設定不要)

initialize.sh が自動検出して .env に upsert するため通常は触らない: DISPLAY / XAUTHORITY_HOST / RENDER_GID / VIDEO_GID / NVIDIA_GPU_UUID / AMD_RENDER_NODE / AMD_VK_DEVICE_SELECT / AMD_DRI_PRIME。既存の ResonitePath はそのまま (/resonite:ro bind の source として再利用される)。

---

6. AppArmor: 非特権 user namespace

pressure-vessel (Steam Linux Runtime) は非特権 user namespace を必要とする。Ubuntu 24.04+ は既定でこれを AppArmor で制限するため、kernel.apparmor_restrict_unprivileged_userns=0 が無いと container 起動が 失敗する (host 側 initialize.sh と container 側 entrypoint.sh の二段で hard fail)。

# 一時 (再起動でリセット)
sudo sysctl kernel.apparmor_restrict_unprivileged_userns=0
# 永続
echo 'kernel.apparmor_restrict_unprivileged_userns=0' | sudo tee /etc/sysctl.d/99-resonite-userns.conf
sudo sysctl --system

---

7. 関連 memory

• reference_pressure_vessel_paths.md — pressure-vessel の filesystem 共有経路
• reference_resonite_modding.md — BepisLoader / BepInEx / bep6resonite テンプレ / ResoniteHooks / Thunderstore packaging
• feedback_camera_v2_constraints.md — Wine sandbox 制約 / Renderite framebuffer 直取り / InterprocessLib / OverlayCamera / Settings API の落とし穴
• feedback_bepinex_renderer_as_framework.md — BepInExRenderer は plugin dir を作らず framework として deploy する規約 (check-gale の判定で重要)

---

8. 実機 mod load 検証手順

just deploy-mod → just resonite-launch (container 内で mod 込み Resonite を起動) → just log で gale/BepInEx/LogOutput.log を tail し、Loading Plugin ResoniteIO 行が出るのを確認 → just resonite-stop の流れ。Codex が container 内で完結できる。詳細な debug 経路は /debug-resonite-mod skill を参照。