Configuring your Amazon Lumberyard environment with Setup Assistant - Amazon Lumberyard

Configuring your Amazon Lumberyard environment with Setup Assistant

Lumberyard Setup Assistant configures and maintains your Lumberyard environment based on your development needs. If you’re continuing from Installing Amazon Lumberyard, Setup Assistant should be running on your desktop. Setup Assistant can also be launched from the Start Menu or desktop shortcuts.

Lumberyard Setup Assistant performs several important functions:

  • Ensures that you have the required runtime software.

  • Ensures that you have the required SDKs.

  • Provides plugins for detected content applications such as Photoshop and Maya.

  • Validates registry settings, paths, and libraries.


         Lumberyard Setup Assistant.

On first run, Lumberyard Setup Assistant presents two options, Try out Lumberyard and Full Install (also known as "Custom Install"). If you’re a content creator, such as a designer or artist, and won’t be compiling code, or if you want to jump right in and use the Lumberyard Editor and tools, select Try out Lumberyard. You can always revisit Setup Assistant to add development features. If you’d like to set up Lumberyard for code development, select Full Install.

You should run Setup Assistant periodically, especially after you make changes to your environment, to validate and repair settings and paths. You can also customize Setup Assistant with a configuration file to easily integrate your specific directory structure.

Note

Some Setup Assistant options require the installation of third-party software and licenses, so make sure that you consult the terms of service before installing third-party software.

Lumberyard Setup Assistant custom installation

With Full Install, you specify how you would like to use Lumberyard. Setup Assistant downloads third-party software and validates that the environment is properly configured based on your choices.

  1. Custom installation begins with specifying how you intend to use Lumberyard.

    
                  Lumberyard Setup Assistant Get Started selection.
  2. Verify the Path is correct for your Lumberyard installation.

  3. Select options based on your development needs:

    • Create, Modify and Build projects - Select this option if you intend to create and build new projects with Lumberyard on the Windows platform, or make changes to the engine, asset pipeline, or other tools.

    • Compile for Android devices - Select this option if you intend to build projects for Android devices.

    • Setup for Linux Dedicated Server - Select this option if you intend to build projects for Linux Dedicated Server.

  4. Select Visual Studio 2017 or Visual Studio 2019.

    Note

    We recommend that you select only one version of Visual Studio - the one that you will use to compile your projects. If both are enabled, you will be asked which compiler to use when you rebuild your project in Project Configurator.

    Important

    The version(s) of Visual Studio selected here will be enabled as build platforms, and Visual Studio Solution(s) will be generated for that platform.

  5. Once you are satisfied with your selections, choose Next to install required software and SDKs.

  6. The Install software and Install required SDKs pages display a red icon if a requirement cannot be found and a green checkmark for installed requirements. Missing optional software and SDKs display a yellow icon. Follow the instructions on each page to install the required software and SDKS.

    
                  Lumberyard Setup Assistant install required sdks.
    Note

    Ensure the Third-party path on the Install required SDKs page is correct for your Lumberyard installation.

  7. Install desired optional software and SDKs on the Install software, Install optional SDKs, and Install plugins pages by following the instructions on each page.

  8. When you have completed installing software and SDKs, the Summary page displays information about your Lumberyard environment. From the Summary page, you can launch the Lumberyard Editor by choosing Launch Editor. If you’d like to choose an existing project or create a new project, choose Configure project to launch Project Configurator.