balandinodidonato / Sound_Design_Internship_21_22

1 stars 0 forks source link

Gamekit 3D Sound Design Internship 21/22 ReadMe

This Project is a fork of the Unity Technologies GameKit3D repository. It is being utilised to for the Sound Design Internship 21/22.

Project Overview

The aim of this project is to produce the audio for the Unity 3D game kit level. The audio is to be fully procedural i.e. produced from scratch. This is facilitated by the Pure Data visual scripting language. Patches produced in Pure Data will be implemented into Unity using middleware such as WWise and converting created PD patches into Wwise plugins using the Heavy Compiler by Enzien Audio.

The created audio aims to be a realistic and more controllable option for the game audio. Demonstrating a gained understanding of procedural audio from research and experimentation while also gaining experience in a professional team setting and using professional version control methods.

Mentor/Project Sponsor

Interns

Using Provided Plugins (or Adding Your Own)

These examples are for a 64-bit Windows device, to do this for mac please refer to the HVCC documentation as this requires a couple extra steps. https://github.com/enzienaudio/hvcc/blob/master/docs/06.wwise.md

Wwise Authoring Plugins

Wwise SDK Installation Folder (EG C:/programfiles(x86))/Audiokinetic/wwise 2019.2.1.7250/Authoring/x64/Release/bin/plugins

Wwise Source Plugins (In Unity)

Project Folder (In this case the repository folder EG C:/github)/Sound_Design_Internship_21_22/Assets/Wwise/Deployment/Plugins/Windows/x86_64/DSP/

Set-Up Instructions

Follow these steps to use this repository.

1. Git & Git LFS

https://git-scm.com

Download the Git from the link above.

The Git installer includes Git LFS by default as a tickbox that is pre-checked but ensure this is the case as git LFS is neccessary to correctly download the repository.

2. GitHub Desktop

https://desktop.github.com

Download the GitHub Desktop from the link above.

The Program will allow you to clone the repository. Click the green Code button on GitHub in the browser and copy the link to the respoitory and put it into the Clone repository via URL tab in GitHub Desktop. Depending on where you save the respotitory it may generate a trust this repository pop-up once it finishes downloading. If you do not accept it will remmove the repository from your system.

3. Unity Editor version 2020.3.18f1

https://unity.com

Download the Unity Hub from the link above.

This will require you to sign in also, then install the unity editor version 2020.3.18f1. Any future release of the unity editor should also work, however, this has not been tested by the maintainers of the repository. Once this has been installed add the repository folder to the unity hub, using the add project button.

4. Wwise version 2019.2.1.7250 (Only neccessary if you plan to add to or change the respository)

https://www.audiokinetic.com/en/

Download the Wwise Launcher from the link above.

This will ask you to sign in then you will need to install Wwise Version 2019.2.1.7250 (change latest to all, 2019.2, 2019.2.1.7250). Install the SDK and at least the windows files. You can then access the project (unity level and wwise project) from the unity tab in the launcher. Newer builds than this are not supported (some minor releases from the same version 2019.2.1. ... are but this was the version that worked for the team). Newer build have not been tested by the repository maintainers.

If you wish to open and mess with the wwise project created for the repository you will need to add the plugins to your own Wwise SDK.

5. Pure Data version 0.52-1 (Only neccessary if you plan to add to or change the respository)

http://puredata.info

Download Pure Data from the link above.

This program requires no further configurtion to work as intended although on MacOS the programm will need to request access to your microphone.

6. Python 2.7 (Only neccessary if you plan to add to or change the respository)

https://www.python.org/downloads/

Download Python 2.7 from the link above.

This needs to be python version 2 not python 3. Due to when HVCC was created.

Make sure that python adds its self to PATH (in Windows this should be an auto checked box but is neccessary for the HVCC to function).

7. Visual Studio

https://visualstudio.microsoft.com/vs/

(Only neccessary if you plan to add to or change the respository) Download Visual Studio from the link above.

This is needed to compiler your wwise plugins and also to edit any scripts in unity. This requires a addon to the C++ components the C++ MFC component

8. HVCC by Enzien Audio (Only neccessary if you plan to add to or change the respository)

https://github.com/enzienaudio/hvcc

Clone the HVCC Repository from the link above.

Refer to the official documentation for the repository when using this tool for the best result and more options. (Quick Process Sum Up)

Extra Info

This Project is a fork of the unity-Technologies repository for their 3D Game Kit. Also Avaliable through the Unity Asset Store. https://github.com/Unity-Technologies/Gamekit3D

https://assetstore.unity.com/packages/templates/tutorials/3d-game-kit-115747