Volograms Unity SDK

This is the Volograms SDK for Unity, in the form of a plugin. You can use this plugin to create an app that plays volograms.

Supported Platforms

• MacOS
• iOS (arm64)
• Windows (win64)
• Android

Getting Started

• The easiest way to get started is to install the Volograms Player package from the Unity Package Manager.

Package Manager > Add package from git URL > https://github.com/Volograms/volograms_unity_plugin.git?path=/VologramsPlayer

• If you would prefer to build the plugin from source, then you can clone this respository, and follow the Developer Guide below.

Developer Guide

Each platform supported has a separate project, and each project contains a README that documents how to build its respective plugin. When a plugin is built, it is copied to the UnityVol folder, which can be dragged and dropped into Unity.

Requirements

iOS and MacOS

To build the volplayer library for iOS and macOS, you must have the Xcode Command Line Tools installed. Xcode itself is NOT necessary.

Android

To build the volplayer library for Android, you must have the Android SDK Command Line Tools installed. Android Studio is NOT necessary.

Windows

The volplayer Windows build is a Visual Studio project, and so you must be able to build such a project, for example, through Visual Studio.

FFmpeg

The Volograms Unity SDK uses builds of FFmpeg.

• For Windows and Linux, you can use pre-built builds from the FFmpeg-Builds repository.
• For Android, you can use ffmpeg-android-maker tool to build FFmpeg for Android.

Then, all you have to do is run the build_plugin.sh script in any of the platform folders.

Note there is currently no build_plugin.sh script for Windows and Linux.

Licence

Copyright 2022, Volograms.

• Source code included in this plugin is provided under the terms of the MIT licence (see the LICENSE file for details).

Dependencies

• This software uses FFmpeg licensed under the LGPLv2.1.