2020-06-29

SideFX Labs Install


SideFX Labs は SideFX が提供する便利なツール集。Houdini 18 以前は Game Development Tools と呼ばれていた。このインストール、共有方法、付随する環境変数について説明する。


なお Houdini 18 より、SideFX Lab は本体インストーラに同梱されている。Houdini インストール時にインストールしておけば、後ほどネットワーク経由でダウンロードすることが不要になった。


以下、使用したバージョン: 18.0.507

1. Houdini 本体からのインストール

基本的にはこちらの日本字幕付きビデオ (約7分) 通りに行えば完了する。

  1. Houdini を起動する。
  2. シェルフのところの '+' ボタンをクリック、Shelves->SideFX Labs をオンにする。
  3. 表示された SideFX Labs シェルフの Update Toolset ボタンをクリックすると次のパネルが表示される。
    • Release: が None の場合、未インストールであるということ
    • 507-embedded は、起動した Houdini のバージョンについてきているツール
  4. Update をクリック。
      更新が正しく行われれば、次のパネルが表示される。
  5. Houdini を一度終了し、再起動する。
      再起動後の SideFX Las シェルフには、多数のツールが追加され、また ホーム(またはマイドキュメント)以下の houdini18.0 ディレクトリには SideFXLabs というディレクトリが追加されている。 houdini.env を書き換えることも不要になった。
  6. これでインストールは終了。
  7. なお、インストールされた SideFX Labs ツールは、デフォルトでは、
    • ファイルは、ホームディレクトリ以下の houdini18.0/SideFXLabs/ に ###-embedded などとして配置され (18.0.507 の場合 507-embedded)
    • そのバージョンやインストール先などの詳細情報情報は houdini18.0/packages/SideFXLabs.json で定義されている。

2. コマンドラインでインストール

コマンドラインツールを起動し、

hython "C:\Program Files\Side Effects Software\Houdini 18.5.640\houdini\python3.7libs\sidefxlabs.py" -d (または -p) 
の要領で実行する。
  • -e: インストールした Houdini のビルド
  • -d: 最新のデイリービルド
  • -p: 最新プロダクションビルド
  • -v 番号: 番号を指定してインストール
  • -u: アンインストール
使うバージョンと Python2.7 か Python3 ビルドかによってディレクトリが変わる。例えば、Python 2.7 の Houdini をインストールした場合は、... 18.5.640\houdini\python3.7libs の代わりに ... 18.5.640\houdini\python2.7libs となる。
詳細はこちらの Method 2。

3. 動作確認

インストールした SideFX Las が正しく動作するか確認するのは以下の3箇所と設定ファイル (SideFXLabs.json)。

  1. デスクトップの確認
  2. シェルフの確認
  3. ツールの確認
まずは、Houdini を起動。

1. デスクトップの確認

    メインメニュー脇の デスクトップのプルダウンをクリックした時に SideFX Labs が存在し、実行時にそのデスクトップになれば、インストールしたデスクトップが正しく認識されている。

2. シェルフの確認

  1. 右側のシェルフであっても、左側であっても、それぞれの右側にある '+' をクリック、 Shelves->SideFX Labs を選択した際に SideFX Labs シェルフが表示されれば、シェルフも認識されている。

3. ツールの確認

  1. Geometry ノードなどを作成し、ネットワークビューでその中で TAB キーを押してメニューを表示すれば、"Labs" というサブメニューが表示される。
  2. 同様に ROP、COP に行っても Labsというサブメニューが表示される。

4. SideFXLabs.json の確認

SideFXLabs のバージョンやインストール先などの詳細情報情報は houdini18.0/packages/SideFXLabs.json で定義されていて、このファイルの中身はデフォルトでは以下のようになっている。

{
    "path": "$SIDEFXLABS", 
    "enable": "houdini_version >= '18.0' and houdini_version < '18.1'", 
    "env": [
        {
            "sidefxlabs_current_version": "507-embedded"
        }, 
        {
            "SIDEFXLABS": "$HOUDINI_PACKAGE_PATH/../SideFXLabs/507-embedded\\SideFXLabs18.0"
        }, 
        {
            "PATH": {
                "method": "prepend", 
                "value": [
                    "$SIDEFXLABS/bin"
                ]
            }
        }
    ]
}
もし、SideFXLabs のビルドを入れ替えたい場合、ここのビルド番号 (507) をインストールされている別の番号で置き換えれば、新しいのにも古いのにも入れ替えることができる。

4. 環境変数 HSITE を使った共用ディレクトリへの配置

一つのPCでインストールした SideFX Labs Tools を部署などで共有する一つの方法が、環境変数 HSITE を使うこと。上記の方法でインストールした SideFX Labs は以下の方法で共有可能。

  1. \\Shared Drive\HoudiniFiles\ が既に存在し、これを共有ディレクトリとする場合、
    HSITE = \\Shared Drive\HoudiniFiles\
    システム環境変数として定義する。houdini.env ではダメ。
  2. \\Shared Drive\HoudiniFiles\ 以下に houdini18.0 ディレクトリを、そしてその中に packages ディレクトリを作成する。
  3. ホーム以下の houdini18.0/SideFXLabs を \\Shared Drive\HoudiniFiles\houdini18.0 ディレクトリ内に移動する。
  4. ホーム以下の houdini18.0/packages/SideFXLabs.json を \\Shared Drive\HoudiniFiles\houdini18.0\packages ディレクトリ内に移動する。
これで SideFXLabs.json を書き換えることなく半自動的に共有が可能。

5. 環境変数 HOUDINI_PACKAGE_DIR を使った共用ディレクトリへの配置

HSITE を使わない場合、HOUDINI_PACKAGE_DIR を使って SideFXLabs.json があるディレクトリを指定することも可能。この場合、SideFXLabs.json 内を編集して、SideFX Labs Tools を配置したディレクトリを正しく設定しなければならない。@takavfx 氏による「SideFX Labs Toolの新規のインストール方法、Package機能に関して検証してみる」が詳しい。

6. その他環境変数

SideFXLabs Github ページには、他に3つの環境変数の説明がある。

  • SIDEFXLABS_NOINSTALL_MESSAGE
      SIDEFXLABS_NOINSTALL_MESSAGE に "<ユーザ定義文字列>" を指定すると、そのコンピュータでの SideFX Labs のインストールを無効化し、定義した文字列を表示する。例えば、以下のように設定すると

      SideFX Labs のUpdate Tools をクリックしたときに以下のように表示される。
  • SIDEFXLABS_ADMIN_UPDATES
      SIDEFXLABS_ADMIN_UPDATES を 1 に設定すると、個々のユーザによる既存インストールのアップデートを無効にする。部署内で同一のビルド番号にそろえる場合に有効。

    SIDEFXLABS_ADMIN_UPDATES と SIDEFXLABS_NOINSTALL_MESSAGE の両方が設定されている場合、SIDEFXLABS_NOINSTALL_MESSAGE が優先される。
  • HOUDINI_ANONYMOUS_STATISTICS

7. ダウングレード

SideFXLabs の Update Toolset ツールを使って任意のビルドにダウングレードする方法はない。例えば 18.0.507 上で 18.0.416 の SideFX Lab を使いたい場合、以下の方法が二つのケースが考えられる。

  1. 使用しているコンピュータに 18.0.416 が既にインストールされ、SideFX Labs も既に一度インストールしてある。
      上記の SideFXLabs.json ファイルをテキストエディタで開き、ビルド番号を2か所置換し、保存する。
  2. 使用しているコンピュータには 18.0.416 はインストールされていない。
    1. Houdini 18.0.416 のインストーラを入手し、Houdini をインストールする。
    2. Houdini 18.0.416 を起動し、上記の要領での 416-embedded をインストール。これは、既存ファイルを上書きしない。
    3. 上記の SideFXLabs.json ファイルをテキストエディタで開き、ビルド番号を2か所置換し、保存する。
SideFXLabs から GameDevTools にダウングレードしたい場合
  • Vertex Animation Textures のようにバージョンが変わったものはこちらの方法が使える。

その他リンク


最終更新 2021-07-23

0 件のコメント:

コメントを投稿