User Guide (Version 1.13)

Running Lumberyard Setup Assistant

Before you run Lumberyard Setup Assistant, verify that 3rdParty.txt appears in the \3rdParty directory and that engineroot.txt appears in the \dev directory. These files are required for Lumberyard Setup Assistant to properly detect third-party software and SDKs.

To use Lumberyard Setup Assistant

  1. Do one of the following:

    • Double-click the Setup Assistant desktop shortcut.

    • Click Setup Assistant in the Start menu.

    • Open the directory where you extracted Lumberyard and run SetupAssistant.bat.

  2. In the Custom Install box, click Customize.

  3. Verify that the engine root path is correct.

  4. On the Get started page, select what you want to do:

    • Run your game project

    • Run the Lumberyard Editor and tools – Use Lumberyard Editor to create a game.

    • Compile the game code* – Compile the game code to include any changes that you have made.

    • Compile the engine and asset pipeline* – Compile the engine code and asset pipeline to include any changes that you have made.

    • Compile the Lumberyard Editor and tools* – Compile Lumberyard tools to include any changes that you have made.

    • Compile for Android devices*

    • Setup for Linux Dedicated Server*

    *If you select any of these options, you may later see new dependencies in the Install software and Required SDKs pages. If so, follow the instructions to obtain each software and third-party SDK that you do not yet have installed.


    If you select the Compile the game code option, you must create a game spec file that includes the configuration to build your game project.

    To create new capabilities and enable and disable these capabilities in a command line environment, use Lmbr.exe.

  5. Select Visual Studio 2013, Visual Studio 2015, or both.


    By default, the Visual Studio 2015 installation does not include C++ as an installed language. In order to build, you must select C++, its child options, and MFC during the Visual Studio 2015 installation. To verify your current installation, in Windows, open the Control Panel and click Programs and Features, Microsoft Visual Studio 2015. Next, select Modify to view or add C++ and MFC support.

    To use both versions of Visual Studio, see Configuring Visual Studio 2013 and 2015 for Lumberyard.

  6. Click Next.

  7. Follow the instructions on each page.

  8. When you have all the required software and SDKs installed for your implementation, click Configure project or Launch Editor. For more information about configuring your project, see Creating Lumberyard Game Projects.

  9. Log in to your existing Amazon account or create a new account to access the editor.

Configuring Visual Studio 2013 and 2015 for Lumberyard

If you are an advanced user and want to use both Visual Studio 2013 and Visual Studio 2015, you must configure the Lumberyard build system (Waf) for each version. Lumberyard uses Waf to generate Visual Studio solutions and to build.

To configure the Waf settings for each Visual Studio version

  1. Navigate to the \dev\_WAF_ directory at the root of your Lumberyard installation.

  2. Use a text editor to open the user_settings.options file.

  3. Under [Visual Studio Project Generator], set msvs_version to 12 for Visual Studio 2013.

  4. In a command line window, navigate to the \dev directory.

  5. Type the following command to configure your build:

    C:Lumberyard\lyengine\dev>lmbr_waf configure

    This generates the Visual Studio solution and build for the version that you specified in the user_settings.options file. The solution is located in the \dev\Solutions directory.

  6. Repeat these steps for Visual Studio 2015. For step 3, set msvs_version to 14 for Visual Studio 2015.