tutorial: installing and configuring lumberyard...tutorial: installing and configuring lumberyard...

13
Tutorial: Installing and configuring Lumberyard This tutorial walks you through the steps to install and configure Amazon Lumberyard to run the Editor and Samples Project. You will learn how to do the following: Install Lumberyard Set up Lumberyard in source control Configure Lumberyard using SetupAssistant Prerequisites You must have the following before starting this tutorial: An internet connection, preferably a fast one. Windows 7 or higher (64bit) Processor Intel Quad-Core (I 2300), AMD Octo-Core (FX810), or better Memory 8 GM RAM or higher Graphics card NVIDIA GeForce 660Ti, Radeon HD790, or better Disk space 60 GB minimum Visual C++ Redistributable Packages for Visual Studio 2013 Step 1: Install Lumberyard Amazon provides two ways to download and install Lumberyard, an online installer that will download and install Lumberyard automatically, and a zip package. The installer is designed to handle varying internet connection speeds and will add the Lumberyard Editor, SetupAssistant and Project Configurator to the Start Menu. Both methods are covered in this tutorial, but we recommend you use the installer unless you need to install Lumberyard offline. To install Lumberyard with the online installer 1. In a web browser, navigate to https://aws.amazon.com/lumberyard 2. Download and run the Lumberyard Installer.

Upload: others

Post on 24-Jan-2020

47 views

Category:

Documents


0 download

TRANSCRIPT

Page 1: Tutorial: Installing and configuring Lumberyard...Tutorial: Installing and configuring Lumberyard This tutorial walks you through the steps to install and configure Amazon Lumberyard

Tutorial: Installing and configuring Lumberyard This tutorial walks you through the steps to install and configure Amazon Lumberyard to

run the Editor and Samples Project.

You will learn how to do the following:

Install Lumberyard

Set up Lumberyard in source control

Configure Lumberyard using SetupAssistant

Prerequisites You must have the following before starting this tutorial:

An internet connection, preferably a fast one.

Windows 7 or higher (64bit)

Processor – Intel Quad-Core (I 2300), AMD Octo-Core (FX810), or better

Memory – 8 GM RAM or higher

Graphics card – NVIDIA GeForce 660Ti, Radeon HD790, or better

Disk space – 60 GB minimum

Visual C++ Redistributable Packages for Visual Studio 2013

Step 1: Install Lumberyard Amazon provides two ways to download and install Lumberyard, an online installer that

will download and install Lumberyard automatically, and a zip package. The installer is

designed to handle varying internet connection speeds and will add the Lumberyard

Editor, SetupAssistant and Project Configurator to the Start Menu. Both methods are

covered in this tutorial, but we recommend you use the installer unless you need to

install Lumberyard offline.

To install Lumberyard with the online installer

1. In a web browser, navigate to https://aws.amazon.com/lumberyard

2. Download and run the Lumberyard Installer.

Page 2: Tutorial: Installing and configuring Lumberyard...Tutorial: Installing and configuring Lumberyard This tutorial walks you through the steps to install and configure Amazon Lumberyard

3. Click the Options button to change the install location.

4. Click Browse to select the location where you want to install Lumberyard or

accept the default location.

NOTE: Install paths with non-latin characters are not supported. If you have a

previous version of Lumberyard installed, do not attempt to overwrite it using the

installer. We also recommend you avoid installing Lumberyard to a location with

a very long path which could lead to path truncation due to Windows path limits.

Page 3: Tutorial: Installing and configuring Lumberyard...Tutorial: Installing and configuring Lumberyard This tutorial walks you through the steps to install and configure Amazon Lumberyard

5. Click OK to confirm the install location.

6. Click Install to begin the installation.

If prompted by Windows for your credentials, provide them and click OK to

continue.

The installer will download and install Lumberyard.

Page 4: Tutorial: Installing and configuring Lumberyard...Tutorial: Installing and configuring Lumberyard This tutorial walks you through the steps to install and configure Amazon Lumberyard

7. After the install completes, click the Launch button to run SetupAssistant, or

press Close to exit the installer.

To install Lumberyard with the zip package

1. Download the zip package from the Lumberyard downloads page.

2. Navigate to the location where you downloaded the file and extract the files to the

location where you want to install Lumberyard. We recommend that you do not

use the built-in Windows extractor because it is slower and can cause installation

of the included software to fail because it blocks certain install files. Examples of

alternate extraction software include 7Zip and WinRar.

NOTE: Install paths with non-latin characters are not supported. If you have a

previous version of Lumberyard installed, do not overwrite it. We also

recommend you avoid installing Lumberyard to a location with a very long path

which could lead to path truncation due to Windows path limits.

You now have Lumberyard installed on your machine, but before you run the editor or

game, you need to configure your environment and install any required 3rd party

software.

Page 5: Tutorial: Installing and configuring Lumberyard...Tutorial: Installing and configuring Lumberyard This tutorial walks you through the steps to install and configure Amazon Lumberyard

Step 2: Set up your development environment After you install Lumberyard, you need to configure your environment to ensure that you

have the correct software and SDKs required for the kind of game (or plugin) you want

to make. Lumberyard comes with a tool called the SetupAssistant (formerly known as

LumberyardLauncher in V1.1 and under) to make this process simple and painless.

To set up your development environment

1. Run SetupAssistant from the Start Menu, or navigate to the folder where you

installed Lumberyard and run SetupAssistant.bat

SetupAssistant will open and show the Get started page.

NOTE: if SetupAssistant fails to open or an error dialog appears, make sure you

have the Visual C++ 2013 Redistributable for Visual Studio installed and then try

again.

Page 6: Tutorial: Installing and configuring Lumberyard...Tutorial: Installing and configuring Lumberyard This tutorial walks you through the steps to install and configure Amazon Lumberyard

2. Verify the Lumberyard install path is correct and select the first two options under

What do you want to do with Lumberyard.

- Run your game project

- Run the Lumberyard Editor and tools

Page 7: Tutorial: Installing and configuring Lumberyard...Tutorial: Installing and configuring Lumberyard This tutorial walks you through the steps to install and configure Amazon Lumberyard

3. Press Next to proceed to the Install software page.

Install all required software by clicking the “Install it” links if you see a red x next

to the software title. Once all required software is installed you should see green

check marks next to each software title.

Page 8: Tutorial: Installing and configuring Lumberyard...Tutorial: Installing and configuring Lumberyard This tutorial walks you through the steps to install and configure Amazon Lumberyard

4. Press Next to proceed to the Install SDKs page.

Install all required SDKs by following the installation instructions for each SDK.

Once all the required SDKs are installed you should see green check marks next

to each SDK.

Page 9: Tutorial: Installing and configuring Lumberyard...Tutorial: Installing and configuring Lumberyard This tutorial walks you through the steps to install and configure Amazon Lumberyard

5. Press Next to continue to the Install plugins page.

This page lists plugins you can install for creating content in other programs and

importing into Lumberyard.

Page 10: Tutorial: Installing and configuring Lumberyard...Tutorial: Installing and configuring Lumberyard This tutorial walks you through the steps to install and configure Amazon Lumberyard

6. Press Next to proceed to the Summary page which has buttons for launching

the editor or configuring a project.

At this point you are ready to run the editor for the sample game project, which is the

default game project for the Lumberyard. To see how to create a new game project

refer to the Create a New Project tutorial.

Page 11: Tutorial: Installing and configuring Lumberyard...Tutorial: Installing and configuring Lumberyard This tutorial walks you through the steps to install and configure Amazon Lumberyard

Step 3: Run the editor Now that you’ve installed Lumberyard and all required 3rd party software you are ready

to run the editor.

To run the editor

1. Run Lumberyard Editor from the Start Menu or click the Launch Editor button

on the Summary page.

Alternately, in Windows Explorer, navigate to the dev\Bin64 folder and run

Editor.exe.

Page 12: Tutorial: Installing and configuring Lumberyard...Tutorial: Installing and configuring Lumberyard This tutorial walks you through the steps to install and configure Amazon Lumberyard

Before the Editor window launches, the Asset Processor will open and begin

compiling assets needed by the Editor and the Samples Project. Not all the

assets are required for the Editor to launch so you won’t have to wait for all

assets to compile before the Editor opens.

2. If this is the first time you are running the editor, the Login to Amazon dialog will

appear. Enter your Amazon.com login information and press Sign In. If you

don’t have an account press the Create an account button and follow the

instructions to create a new Amazon account.

Page 13: Tutorial: Installing and configuring Lumberyard...Tutorial: Installing and configuring Lumberyard This tutorial walks you through the steps to install and configure Amazon Lumberyard

3. After logging in, the editor main window will appear.

Congratulations! You now have Lumberyard installed and running on your machine.

Related tasks and tutorials Now that you have downloaded and installed Lumberyard, see what else you can do:

Tutorial: Editor overview

Tutorial: Upgrading your game projects

Tutorial: Setting up your development Environment

We’d love to hear from you! Head to our Tutorial Discussion forum to share any

feedback you have, including what you do or don’t like about our tutorials or new

content you’d like to see in the near future.