Lumberyard
User Guide (Version 1.19)

Quick Start: Running the Samples Project on iOS Devices

You can use this quick start to learn how to run the Samples Project on your iOS device from a macOS computer.

This topic assumes that you have:

  • Xcode installed on your macOS computer

  • Lumberyard installed on your macOS computer

  • An iOS device connected to your computer with a USB cable

  • Lumberyard installed on a Windows computer

  • Remote Shader Compiler running on your Windows or macOS computer

For more information about creating iOS apps, see iOS Support.

To run the Samples Project on an iOS device

  1. Use Lumberyard Setup Assistant to install the required third-party software and SDKs for iOS.

    1. On your macOS computer, navigate to the lumberyard_version\dev\Tools\LmbrSetup\Mac\ directory and double-click SetupAssistant.exe.

    2. If you see a Custom Install box, click Customize and then verify that the engine root path is correct.

    3. On the Get Started page, select the following:

      • 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 iOS devices

    4. Complete the Lumberyard Setup Assistant wizard. For more information, see Running Lumberyard Setup Assistant.

  2. Configure Asset Processor for iOS.

    1. Use your preferred text editor to open the AssetProcessorPlatformConfig.ini file. You can find this file in the lumberyard_version\dev\ directory.

    2. Remove the preceding semicolon to uncomment ios=enabled.

      [Platforms] ;pc=enabled ;es3=enabled ios=enabled ;osx_gl=enabled
    3. Save the file.

  3. Launch Asset Processor.

    1. Navigate to the following directory and double-click AssetProcessor.exe:

      • On Windows: lumberyard_version\dev\Bin64vc140\

      • On macOS: lumberyard_version\dev\BinMac64\

    2. In Asset Processor, verify that the Status is Idle.

      Idle status in Asset Processor.
  4. In a command line or Terminal window, do the following:

    1. Change directory to the lumberyard_version\dev\ directory.

    2. Type the following:

      • On Windows: lmbr_waf.bat configure

      • On macOS: sh lmbr_waf.sh configure

  5. On your Windows or macOS computer, set the IP address for the remote shader compiler server.

    1. Use your preferred text editor to open the system_ios_ios.cfg file. You can find this file in the lumberyard_version\dev\ directory.

    2. Set r_ShaderCompilerServer to the IP address of your Windows computer that runs the shader compiler.

    3. Save the file.

  6. Build and deploy the code.

    1. Navigate to the lumberyard_version\dev\Solutions\ directory and open the LumberyardiOSSDK.xcodeproj file.

    2. Click Run to build and deploy the code to your iOS device.