4 Global State (GS File)

The global state file (GS file) is a json file which stores a default configuration of settings for NDICmd to use when executing commands. A global state can be created manually in a text  or NDICmd can create and write to the file through the SetGS and SaveGS commands. When the LoadGS command or /gs switch are used in an NDICmd command sequence, the values in the file will be used as the default for any required parameters which are not specified. The default file location for both the switch and commands is "C:\Users\<User>\AppData\Local\Nintendo\NDI". GS files may be saved and loaded from other locations.

Multiple GS files can be created and referenced as a way to reference different software environments and development hardware devices. The values which may be added to the global state are as follows.

  • SecondsBeforeTimeout: Integer defining the consecutive seconds of inactivity before the command times out.
  • Login Object
    • ServerID: String defining the server name to be accessed. This name must come from the list of servers accessible to NDI. 
    • DataLocale: String defining the desired language for downloaded packages. Must be either "en" or "ja".
    • UserName: String defining a user name available to the server specified by ServerID.
    • NonInteractivePassword: String defining the password for the user name specified by UserName
    • SavePassword: Boolean defining if the password for a user name will be saved by the program for later access to the server.
    • Retries: Integer defining the number of times will attempt to connect to the server before the command fails.
  • RemoveGlobalsAfterLastEnv: Boolean defining if global packages (those available to all environments) are removed after the last environment is deleted by NDICmd.
  • StopOnFirstInstallFailure: Boolean defining how the installation responds to a failed installation. A value of true indicates that the command will stop execution when a package fails installation.
  • DownloadCachePath: String defining the path to the system location where packages downloaded by NDICmd are stored.
  • DefaultEnvironment Object
    • RootDir: String defining the path to a system location where files will be installed when creating environments.
    • Name: String defining the name NDI uses to track the created environments.
  • DefaultDevkit Object
    • Platform: String defining the type of platform for a development hardware device. Such as "NX" or "Wii U".
    • Identifier: String defining an identifier for a development hardware device of the type defined by Platform. For Wii U development hardware, this is the name of the device. For NX development hardware, this is the IP Address of the device.

 


CONFIDENTIAL