Getting Started

What dev machines does the Unity SDK run on?

  • The LeiaLoft Unity SDK runs in Unity 2017 LTS (2017.4.40f1), 2018 LTS (2018.4.23f1), 2019 LTS (2019.4.3f1) & 2020.2.

  • Development can be done from within Unity on a Mac, Linux, or Windows machine

Which LitByLeia™ devices does the Unity SDK support?

  • Hydrogen and Lumepad

  • Devs should expect their products to be distributed using the LeiaLoft™ store

Project Setup Steps

  1. Delete your previous LeiaLoft Unity SDK folder if it exists

    • at <project_path...>\Assets\LeiaLoft\

  2. Download the LeiaLoft Unity SDK: https://www.leialoft.com/tools

  3. Import the LeiaLoft Unity SDK .unitypackage into your Unity project.

    • While Unity is running, double-click the .unitypackage or

    • Drag the .unitypackage into your Unity project's Assets folder

  4. Follow the Recommended Unity Settings window. If this does not pop up automatically, it can be found in LeiaLoft > Recommended Unity Settings or Alt + R

Conversion Steps for New and Existing Projects

  1. Follow the project setup steps.

  2. Attach the LeiaCamera.cs script to your Camera GameObject.

  3. Follow Content Design Guidelines.

Quick Design Steps

  1. Start by encompassing your game content in the Leia Frustum.

  2. Set focus plane to where the viewer should be looking.

    a. Text / UI looks best when in focus.

  3. Set baseline scaling to determine the amount of depth or size of your Leia Frustum.

  4. Switch to 2D mode when no 3D content is displayed.