4. グローバルステート(GS ファイル)

グローバルステートファイル(GS ファイル)は、コマンドの実行時に NDICmd が使用する設定のデフォルト構成を保存する Json ファイルです。グローバルステートはテキスト形式で手動で作成できます。また、NDICmd で SetGS コマンドを使用してファイルを作成したり、SaveGS コマンドを使用してファイルに書き込んだりすることもできます。NDICmd コマンドシーケンスで LoadGS コマンドまたは /gs スイッチを使用すると、必須パラメータの中で指定されていないものがあった場合に、GS ファイルの値がデフォルトとして使用されます。このスイッチとコマンドのファイルのデフォルトの場所は、"C:\Users\<ユーザー>\AppData\Local\Nintendo\NDI" です。GS ファイルは、他の場所に保存することも、他の場所からロードすることもできます。

異なるソフトウェア環境や開発用ハードウェアデバイスを参照するための 1 つの方法として、複数の GS ファイルを作成して参照することができます。グローバルステートに追加できる値は次のとおりです。

  • SecondsBeforeTimeout:連続して非アクティブ状態になっている時間(秒)を定義する整数。この時間を超えると、コマンドはタイムアウトになります。
  • Login オブジェクト
    • ServerID:アクセスするサーバーの名前を定義する文字列。この名前は、NDI がアクセス可能なサーバーの一覧に含まれているものにする必要があります。
    • DataLocale:ダウンロードパッケージの対象言語を定義する文字列。"en" または "ja" のいずれかである必要があります。
    • UserName:ServerID で指定したサーバーで使用可能なユーザー名を定義する文字列。
    • NonInteractivePassword:UserName で指定したユーザー名のパスワードを定義する文字列。
    • SavePassword:後でサーバーにアクセスするときのためにプログラムでユーザー名のパスワードを保存しておくようにするかどうかを定義するブール値。
    • Retries:サーバーへの接続試行回数を定義する整数。この回数を超えると、コマンドは失敗します。
  • RemoveGlobalsAfterLastEnv:NDICmd によって前回の環境が削除された後にグローバルパッケージ(すべての環境で使用可能なパッケージ)を削除するかどうかを定義するブール値。
  • StopOnFirstInstallFailure:インストール時にインストールが失敗した場合の処理を定義するブール値。値 true は、パッケージのインストールが失敗した場合にコマンドの実行を停止することを示します。
  • DownloadCachePath: NDICmd によってダウンロードされたパッケージが保存される、システム上の場所のパスを定義する文字列。
  • DefaultEnvironment オブジェクト
    • RootDir:環境作成時にファイルがインストールされるシステム上の場所のパスを定義する文字列。
    • 名前:作成された環境を追跡するために NDI で使用する名前を定義する文字列。
  • DefaultDevkit オブジェクト
    • Platform:開発用ハードウェアデバイスのプラットフォームのタイプを定義する文字列。例えば、"NX" または "Wii U" などです。
    • Identifier:Platform で定義されたタイプの開発用ハードウェアデバイスの識別子を定義する文字列。開発用ハードウェアが Wii U の場合、これはデバイスの名前になります。開発用ハードウェアが NX の場合、これはデバイスの IP アドレスになります。