From e64fb1ce9de301fd6706f4e79169babdcaa56c2a Mon Sep 17 00:00:00 2001 From: "Dipl.-Ing. Jonas Stienen" Date: Mon, 7 Aug 2017 15:55:56 +0200 Subject: [PATCH] Add new file --- README.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..de596d8 --- /dev/null +++ b/README.md @@ -0,0 +1,31 @@ +# VAUnity + +VAUnity provides scripts to ease usage of the VA C# binding within Unity. For example, you can use the VAUSoundSource script and drop it on a sound source object in order to connect it with a VA sound source. + +# Quick build guide + +Clone the repository into the assets folder of your Unity scene. + +# Howto + +If you see the VAU* scripts in your Unity scene, you can start to extend your objects by sound source and listener(s). + +## Connect to VA + +To connect to VA, drag&drop the VAUAdapter script on any GameObject. It is recommended to create a top level empty GameObject named "VAConnection". + +## Listener + +Drag&drop the VAUListener script onto the camera rig / ears to create a dynamic listener in VA. The Script will update the pose accordingly based on the transform, i.e. if the movement is connected to a tracking device, the tracked data will be forwared to VA. + +## Sound source + +Drag&drop the VAUSoundSource script onto any sound object to create a VA sound source. The Script will update the pose accordingly based on the transform, i.e. if the movement is connected to a tracking device, the tracked data will be forwared to VA. + +## Auralization modes + +You can control the auralization modes via the VAAuraMode script. Auralization modes are either controlling sound sources, listeners or are set globally. VA will only auralize a certain effect, if effects are active for all three, i.e. uses a logic AND combination. + +# Extensions + +Have a look at the VAUnityExtensions project to get 3D user interfaces that control VA using menues, like muting, sound level control, direkt auralization mode manipulation and more. -- GitLab