Menu
Lumberyard
User Guide (Version 1.13)

Using Lumberyard Setup Assistant Batch

The command line version of Lumberyard Setup Assistant is useful for server and build administrators and those who would like to create a batch file to run the same configuration on multiple machines.

The command line version of Lumberyard Setup Assistant is provided in the \dev\Tools\LmbrSetup\Win directory as an executable file called SetupAssistantBatch.exe.

You can also use Lmbr.exe to create new capabilities, enable and disable capabilities, and to modify your projects and gems.

To use Lumberyard Setup Assistant Batch

  1. Open a command prompt.

  2. Change the directory to where you extracted Lumberyard.

    Example: cd D:\lumberyard-build\dev\Tools\LmbrSetup\Win

  3. Run the SetupAssistantBatch.exe.

    Example: D:\lumberyard-build\dev\Tools\LmbrSetup\Win\SetupAssistantBatch.exe

  4. Modify as needed. See the commands list below.

Commands

Command Description
--help Lists all commands and descriptions
--3rdpartypath Sets the third-party directory to the specified parameter
--sdkpath Sets the location of the Lumberyard SDK to the specified parameter

Note

This command expects a root where Lumberyardroot.txt is located.

--disablecapability Disables the specified tasks (capabilities):
  • Run your game project

  • Run the Lumberyard Editor and tools

  • Compile the game code

  • Compile the engine and asset pipeline

  • Compile the Lumberyard Editor and tools

  • Compile for Android devices

  • Compile for iOS devices

Note

Tasks are disabled by default.

--enablecapability Enables the specified tasks:
  • Run your game project

  • Run the Lumberyard Editor and tools

  • Compile the game code

  • Compile the engine and asset pipeline

  • Compile the Lumberyard Editor and tools

  • Compile for Android devices

  • Compile for iOS devices

--all Enables all tasks
--none Disables all tasks
--no-modify-environment Prevents Lumberyard Setup Assistant from changing your environment variables

Examples

The following example sets the paths, clear all selected tasks, and set the selected task as "Run game":

setupassistantbatch.exe --3rdpartypath "d:\lumberyard_version\3rdParty" --sdkpath "d:\lumberyard_version\dev" --none --enablecapability rungame

If the command runs smoothly, the exit code for this program is 0.

The following example disables all tasks (capabilities) and enable only the compilation tasks. This is common for hosting a build server:

setupassistantbatch.exe --none --enablecapability compilegame --enablecapability compileLumberyard --enablecapability compilesandbox

On this page: