Lumberyard
User Guide (Version 1.16)

Downloading Lumberyard

Use the Lumberyard Installer to download Lumberyard. After installation, you can use Lumberyard, Lumberyard Editor, and other engine tools.

Note

Verify that you have the required hardware and software for Lumberyard. For more information, see System Requirements.

Using the Lumberyard Installer to Download Lumberyard

To install Lumberyard, download the LumberyardInstaller.exe. The Lumberyard Installer extracts the Lumberyard files and adds shortcuts on your desktop and in the start menu for the following:

  • Lumberyard Setup Assistant

  • Project Configurator

  • Lumberyard Editor

If your download is interrupted, the installer resumes the download automatically. By default, the Lumberyard Installer uses c:\Amazon as the root directory and the version number. You can specify a different directory; however, we recommend that you use the default.

If you have an existing Lumberyard project and you want to upgrade, see Upgrading Lumberyard.

Note

If you encounter file errors during extraction about AssetProcessor.exe, AssetProcessor_temp.exe, or CrySystem.dll, verify if your antivirus software is placing these files in quarantine. If needed, grant exceptions for the affected files.

To download Lumberyard with the installer

  1. On the Lumberyard Downloads page, click Download Now.

  2. Navigate to your download directory and run the Lumberyard Installer executable file: LumberyardInstallerversion_number.exe

  3. On the Welcome page of the installer, click Install to install to the default location.

  4. Follow the instructions to complete your installation.

  5. On the Installation Successfully Completed page, click Launch Lumberyard Setup Assistant to install required third-party software and SDKs. For more information, see Running Lumberyard Setup Assistant.

Using GitHub to Download Lumberyard

Each Lumberyard release exists as a separate branch in GitHub. Follow the instructions on the Amazon Lumberyard page on GitHub to download Lumberyard.

Lumberyard Directories and Files

After you install Lumberyard, the Lumberyard root directory includes the following folders and files:

  • dev

    • _WAF_ – Waf build system files.

    • Bin64 – Binaries directory and configuration files for the Resource Compiler.

    • Bin64vc141 – Binaries directory and configuration files for Visual Studio 2017.

    • Bin64vc140 – Binaries directory and configuration files for Visual Studio 2015.

    • Code – Source files directory and solution files.

    • Editor – Editor assets.

    • Engine – Engine assets.

    • Gems – Optional systems and assets.

    • MultiplayerSample – Multiplayer sample project that demonstrates how to build a multiplayer game with the new component entity system. For more information, see Multiplayer Sample.

    • ProjectTemplates – Configuration files, libraries, and scripts for the empty template.

    • SamplesProject – Sample project. For more information, see Samples Project.

    • Tools – Third-party tools and plugins.

    • engineroot.txt – System file required by Lumberyard Setup Assistant.

  • 3rdParty

    • Third-party software required to use or compile Lumberyard

    • 3rdParty.txt – System file used by other third-party tools to verify the directory.

  • docs