Updating README and LICENSE for open source release

parent e1e43f6d
Copyright 2015-2017 Institute of Technical Acoustics, RWTH Aachen University
Copyright 2015-2017 Institute of Technical Acoustics (ITA), RWTH Aachen University
Licensed under the Apache License, Version 2.0 (the "License");
you may not use files of this project except in compliance with the License.
......
# VAUnity
## VAUnity
VAUnity provides scripts to ease usage of the VA C# binding ([VACS](http://git.rwth-aachen.de/ita/VACS)) within Unity. For example, you can use the VAUSoundSource script and drop it on a sound source object in order to link it with a VA sound source.
# Quick build guide
### License
Copyright 2015-2017 Institute of Technical Acoustics (ITA), RWTH Aachen University
Licensed under the Apache License, Version 2.0 (the "License");
you may not use files of this project except in compliance with the License.
You may obtain a copy of the License at
<http://www.apache.org/licenses/LICENSE-2.0>
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
### Quick build guide
Clone the repository into the assets folder of your Unity scene.
# Howto
### Howto
If you see the VAU* scripts in your Unity scene, you can start to extend your objects by sound sources and listener(s).
## Connect to VA
#### Connect to VA
To connect to VA, drag&drop the VAUAdapter script on any GameObject,. It is recommended to create an empty top level GameObject named "VAConnection".
## Listener
#### 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
#### 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
#### 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.
## Prefabs
Unity has the possibility to create so called prefabs, that combine GameObjects, scripts and settings. You can also use the provided prefabs, like VA.prefab, to create objects that are already configured and are ready to use.
# Extensions
### Extensions
Have a look at the [VAUnityExtensions](http://git.rwth-aachen.de/ita/VAUnityExtensions) project to get 3D user interfaces that control VA using menus, like muting, sound level control, direct auralization mode manipulation and more.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment