2 Quick Start

When Nintendo Developer Interface (NDI) is installed, the NDICmd program is also installed and added to the system path. This section demonstrates how to setup NDICmd and the creation and update of an initial environment. To begin, complete the following steps.

  1. NDICmd stores its current configuration in an object named the Global State, which is saved to a file. To generate a default Global State file, type the following at a command prompt.

    ndicmd SaveGS %LocalAppData%\Nintendo\NDI\NDICmdGS.json

    The default Global State file may be loaded at a later time using the /gs switch in a command.

  2. Open the generated Global State file in a text editor and edit the following properties. Make sure to surround any properties containing text with quotation marks, and use two backslashes for the path separator in properties containing paths.

    1. Change the ServerID property to the connected server. For example, "Nintendo Developer Portal". When installing a package offline using packages in the local cache, change this property to "Use package manifest file in current cache location". When installing packages offline, all packages that will be installed and a valid manifest file for those packages must be in the cache.

    2. Change the UserName property to your Nintendo Developer Portal username. For example, "MyUsername".

    3. Change the DownloadCachePath property to the directory where you want downloaded packages to be saved. For example, "C:\\NDI\\Cache".

    4. Change the RootDir property to the directory where you want to install the default environment. For example, "C:\\NDI\\Env".

    5. Change the Name property to the name you want to give to the default environment. For example, "Env1".

    6. Change the Identifier property to the identifier of the development hardware you want to be the default. This is optional, and is used when updating development hardware. For example, "DevSystem1".

  3. After editing the Global State file, the next step is to create an environment. Run the following command, replacing the command line parameters with appropriate values.

    ndicmd /i /gs Create "Name" "Platform" "Toolset" "Foundation"

    For example, the following command will create an environment for the Switch SDK.

    ndicmd /i /gs Create "Env1" "Nintendo Switch" "Standard" "NintendoSDK"

    For more information, see the Create command documentation.

  4. After the environment is created, install any desired packages into the environment. Run the following command, replacing the command line parameter with the family of the package to be installed.

    ndicmd /i /gs Install "Family"

    For more information, see the Install command documentation.

  5. To update a package, run the following command, replacing the command line parameter with the family of the package to be updated.

    ndicmd /i /gs Update "Family"

    For more information, see the Update command documentation.

  6. Instead of updating a single package, all packages can be updated at the same time by running the following command.

    ndicmd /i /gs UpdateAll

    For more information, see the UpdateAll command documentation.


 


CONFIDENTIAL