Skip to content

Unity Installation

Overview

This document provides the details on how to install and set up a development environment for the Unity portion of the Danceology project. All of the following documentation will assume a certain amount of familiarity with Unity and Git/GitHub technologies.

Unity Project

https://github.com/ETCDanceology/Danceology-Unity

Tech Requirements

Unity

The Danceology Unity project is developed in C# within the Unity game engine version 2021.3.15f1.

Unity provides download instructions for Unity Hub and the Editor itself; the specific version used for this project can be found here.

It is recommended to modify Unity files using the Visual Studio IDE.

ML Model

Within the Unity application, we used a customized .onnx build of an OpenPose machine learning model.

The ML model is currently being stored and distributed within the Unity Project repository using Git LFS.

Installation Steps

  1. Download and install Unity Hub and Unity Editor version 2021.3.15f1. When downloading the Editor, ensure that you add modules for all the platforms you wish to build for (usually, this includes Windows, Linux, and Mac)
  2. Clone the Danceology Unity repository locally
  3. Open Unity Hub -> Projects -> Open -> Select the Danceology project folder

Development Setup

Util Functions

In Unity, clicking on the Play button will start running the game from the currently open scene. However, as most development tends to happen in a separate scene from the starting one, it becomes bothersome to manually swap scenes before running.

As a shortcut, you can click on Util -> Set Starting Scene to automatically set the default starting scene to the "StartScene" scene. This shortcut will need to be clicked once every time the editor is first opened.

Play Mode

To run a Unity game in the Editor, click on the Play button at the top of the window. This will automatically direct you to the game mode screen.

All of the UI was built to best work on a "Full HD" aspect ratio. You can use the dropdown at the top of the game screen to adjust the screen ratio.