Unity Requirements and Limitations

This document specifies the requirements and limitations of Unity projects hosted on the AppMana streaming platform.

This document is an up-to-date list of requirements and limitations for using the AppMana platform with Unity.

Requirements and Limitations for Streaming

  • Unity 2021 LTS or higher.
  • For streaming targets, you can use Built-In Render Pipeline, HDRP or URP. For WebGL, only Built-In Render Pipeline and URP are supported.
  • The camera connected to your Remote Playable Configuration and the game object must never be destroyed (marked as DontDestroyOnLoad).
  • You can develop on a Windows or macOS device. Vulkan, DirectX 11, DirectX 12 or DirectX DXR will be used to render your game.
  • You must use InputSystem 1.3 or later. Input.mousePosition and other legacy input approaches are not supported. See here for migration tips. To ease migration, use AppMana.Compatibility.Input.
  • You cannot use overlay canvases. Use Camera Space in your canvases. In HDRP, use a custom pass to bypass postprocessing in your screen space canvas. See the HDRP template for a complete example.
  • A Constant Physical Size setting for your Canvas Scaler is recommended for responsive layout on mobile and desktop screens.
  • Use the AppMana.Compatibility.Screen class instead of UnityEngine.Screen.
  • PlayerPrefs are not supported. Use AppMana.Compatibility.PlayerPrefs or the RemotePlayableConfiguration.playerPrefs property.
  • When using input actions, any .performed += and .canceled += handlers should be declared on the input actions asset actions retrieved from RemotePlayableConfiguration.actions asset property in a Start or later; all InputActionReference fields and properties should be declared in implementations of IHasInputActionReferences. AppMana replaces the input action map in RemotePlayableConfiguration.Awake, and undeclare input action references will not be enabled for streaming.

Requirements and Limitations for Unity Package Manager

  • Do not use SSH URLs for git packages in Packages/manifest.json. URLs beginning with git@github.com: require SSH key authentication that is not available in the AppMana build environment. Use HTTPS URLs instead:

    // Not supported
    "com.example.package": "git@github.com:org/package.git"
    
    // Supported
    "com.example.package": "https://github.com/org/package.git"
    

Requirements and Limitations for WebGL

Please refer to the Unity documentation for up-to-date limitations and prerequisites for developing WebGL experiences using Unity. In addition to the documented requirements, augmented reality experiences require platforms with inertial motion support such as mobile devices.