事前にPoetryを導入しておく。
poetry install
poetry run python script/launch.py
Poetryの基本的な使い方はPoetryをサクッと使い始めてみるを参照。
ハードウェア | 要件 | 備考 |
---|---|---|
CPU | Intel / AMD の64bit CPU | |
GPU | NVIDIA GPU | AMD Radeonでも技術的には対応可能と思われるが、未検証。 |
ディスプレイ | FHD以上の画質のディスプレイ | VRChatの起動のため。 |
-
Linux Desktop OS、特に Ubuntu Desktop 22.04 LTS以降。(他のLinux OSでも依存アプリケーション(VRChatなど)が正常にインストールできれば問題ない。)
NOTE: VRChatやOBSを起動するためにはDesktop環境が必須
NOTE: 比較的新しいGPUに対応するため、直近のUbuntuリリースを使うことが望ましい。Ubuntu 22.04ではGeforce RTX 3060を認識せず、インストール時に画面表示ができない不具合があった。23.10にバージョンを変更することで解決した。
-
最新の安定版 NVIDIA Driver(2024/03/23 時点では version 550)
Ubuntuの場合は
sudo ubuntu-drivers install
でハードウェアに最も適したドライバーが自動でインストールされる。
-
Steamをインストール。
https://store.steampowered.com/about/ からDEBファイルをダウンロードし、
sudo dpkg -i steam_latest.deb; sudo apt install --fix
を実行。NOTE: NVIDIA Driverのバージョン525以下ではSteamが正常に動作しないため注意。(提供されている最新の安定版Driverを使うこと。)
NOTE: Snap版のSteamではVRChatをインストールできないため、使わないこと。Steamの公式ページからdebファイルをダウンロードしインストールする。
-
Steamの設定で「互換性」「他のすべてのタイトルでSteam Playを有効化」をオンにする。
-
VRChatをインストール。
vrchat-ioのドキュメンテーションを参考に、VRChatやOBSをインストールする。
VRChatやOBSなどのホストOSに依存したものを除いた、Pythonなどの開発環境はDockerイメージにまとめてある。
Linux OSに事前に次のツールをインストールしておく。
-
Docker
Dockerの公式ドキュメンテーションを参考にインストールを行う。
sudo
なしでDockerを操作するためには以下の手順を実行する。 -
NVIDIA Container Toolkit
NVIDIA Container Toolkitをインストールする。
コンテナラインタイムをDocker用に設定する。
-
make
Ubuntu Desktopではプリインストールされていないため、
sudo apt install build-essentials
でインストールする。
次のコマンドでイメージをビルドし、起動する。
# project root. (ami/)
make docker-build
make docker-run
後は、VSCodeなどのエディタからDockerコンテナにアタッチし、 /workspace
ディレクトリで作業を行う。このディレクトリはホストOSの永続ボリュームであるため、Dockerのコンテナインスタンスを削除しても作業内容はホストOSに保存される。
追加のドキュメントはWikiに整備予定。
2024/11/10時点で、キャプチャを行なっているオーディオデバイスを動的に入れ替える機能が存在しない。そのため、音声モダリティを使う設定で、システム起動後に出力デバイスを変えないよう注意が必要である。(リモートデスクトップでもデバイスが変わる。)