Skip to content

Latest commit

 

History

History
71 lines (42 loc) · 3.25 KB

README.md

File metadata and controls

71 lines (42 loc) · 3.25 KB
Raw

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 - Excluding M1 Macs.
  • iOS
  • Windows
  • Android - Work-in-progress, expect issues!

Support is planned for M1 macOS and GNU/Linux builds.

Getting Started

  • The easiest way to get started is to download a pre-built plugin from the Releases page.
  • If you would prefer to build the plugin from source, then you can clone this respository, and follow the Developer Guide.

Unity Settings

The libraries are exported into the VologramsToolkit folder. The VologramsToolkit folder can be imported directly into Unity.

After importing the plugin into Unity, ensure that the Unity settings for each plugin are correct. For example, we don't want to use the iOS plugin in a macOS build.

There is a utility script included in the Unity package that re-imports all the libraries into Unity with the correct settings. This can be invoked in Unity through the toolbar: Volograms > Utils > Reimport Plugins > All.

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 created from the ffmpeg-kit repo. To start developing on the Volograms Unity SDK, clone the ffmpeg-kit repository and follow the instructions to build FFmpeg for the platforms you want.

Next, open your terminal and add an environment variable FFMPEG_KIT which should point to the root folder of your local ffmpeg-kit repository. For example:

export FFMPEG_KIT="/path/to/ffmpeg-kit"

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.

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.
  • The source code distribution, build instructions, and further licence details can be found at ffmpeg-kit repo