Menu
Sign In to the Console
Lumberyard
User Guide (Version 1.13)

AWS Documentation » Amazon Lumberyard » User Guide » Creating Lumberyard Game Projects » How the Project Configurator Works

How the Project Configurator Works

This feature is in preview release and is subject to change.

The Project Configurator is the Lumberyard application for creating and changing the settings that affect building and editing of the game project. After installation you see two other Lumberyard applications – Lumberyard Editor and Lumberyard Setup Assistant. The configurator, assistant, and editor can not be open simultaneously; however, you can work seamlessly as they off the option to open one and close the other.

If you understand which settings the Project Configurator changes, you can troubleshoot and debug your projects more efficiently. For example, if you want to include or exclude gems, code and assets files that specify game extensions, you use Project Configurator. If some of the menus are not available while working within the editor, you can enable the appropriate gems to add them to your project and then use them from the editor.

The configurator provides the following user interfaces:

  • Summary page displaying the Lumberyard games available to the editor.

  • System Entity Editor providing access to project settings for your operating system and development environment.

  • Gem page to view code and asset extensions and to specify which extensions are available to the editor while developing your game project.

Change advanced project settings using the System entity editor available in the Project Configurator
Change advanced project settings using the System entity editor available in the Project Configurator

has the following

Change advanced project settings using the System entity editor available in the Project Configurator

The following describes what the Project Configurator is doing when you perform certain actions.

Set Default (Active) Project

When you set the default or active project, the Project Configurator modifies the following files with the following information:

\dev\bootstrap.cfg

The property sys_game_folder specifies the project that the editor and PC launcher attempts to load.

\dev\_WAF_\user_settings.options

The property enabled_game_projects is a comma-separated list of one or more projects to include in a build.

Create a New Project

When you create a new project in the Project Configurator, several things happen:

  • EmptyTemplate is used to create a new project. This template is located in dev/ProjectTemplates/EmptyTemplate.

  • The contents of /dev/ProjectTemplates/EmptyTemplate/code/EmptyTemplate are copied to /dev/code/NewProjectName.

  • The contents of /dev/ProjectTemplates/EmptyTemplate/EmptyTemplate are copied to /dev/NewProjectName.

  • EmptyTemplate is replaced in both new locations with the name of your new project, including file names and file contents.

Enable or Disable Gems

When you use the Project Configurator to enable or disable a gem in a project, the Project Configurator updates the list of enabled gems that is maintained in dev\Project_Asset_Folder\gems.json.

  • Disabling a gem removes that gem name from the list in gems.json.

  • Enabling a gem adds that gem name to the list in gems.json.

Create a New Gem

When you use Project Configurator to create a new gem, the following takes place:

  • The content of the gem template (which is part of the Project Configurator resources and is not directly accessible) is copied into \dev\Gems\Gem_Name.

  • Strings with the gem name in the copied content are substituted with your gem's name to make it a valid gem.