Getting Started

• Add Odin Serializer to your project.
  • Note that you must download the version from their website that creates a .unitypackage.
  • If you don't you will need to follow the steps below in [Github/Source Odin Serializer Installation](#Github/Source Odin Serializer Installation)
  • Change your project's API Compatibility Level to .NET 4.x or .NET Framework (Edit -> Project Settings -> Player -> Other Settings -> API Compatibility Level)
  • Enable the Allow 'unsafe' code option (Edit -> Project Settings -> Player -> Other Settings -> Script Compilation)
• Add the Unity Editor Coroutines package to your project.
  • Window -> Package Manager -> Search for Editor Coroutines -> Click Install
• Add PlayRecorder as a package from the Package Manager. This can be done in two ways, either from a Git URL, OpenUPM, or by downloading this repo.
  • Git URL Method
    • Press Add package from git URL... and enter https://github.com/ultraleap/PlayRecorder.git
    • If you wish to specify a specific version or branch you can do so as https://github.com/ultraleap/PlayRecorder.git#branch or https://github.com/ultraleap/PlayRecorder.git#1.1.0
  • OpenUPM
    • Installation instructions can be found at https://openupm.com/packages/com.ultraleap.playrecorder/#modal-manualinstallation
  • Local Package Method
    • Download the repo or release code and extract it to a folder within your project
    • Press Add package from disk... and select the package.json file from your local files

As a general rule of thumb, PlayRecorder has a lot of information stored within tooltips in Unity. If you're requiring more information about a field, try hovering over it within the Unity Editor and you should see a more detailed explanation.

Once you've completed the above stages you're ready to start 🔴 recording and ▶ playing.

Github/Source Odin Serializer Installation

If you download OdinSerializer from Github, it will not include the Assembly Definition file needed for modern Unity package usage. These steps show you what you need to do.

• Download the OdinSerialzier repo and navigate to the OdinSerializer folder.
• Copy the OdinSerializer folder to your Unity project Assets folder.
  • This can be within any folder you like.
• Create a new Assembly Definition file in the OdinSerializer folder.
  • Right click within your assets
  • Create -> Assembly Definition
• Name it OdinSerializer, and check the Allow unsafe Code option, then press Apply.
• Once you do so Unity will compile as normal.