- Kitty Zhuang
- Claire S
- Ethan Goldfarb
- Adam Perlin
- Unity 2019.4.17
- git
- OpenCV For Unity
- code editor or IDE, preferably Visual Studio
- Clone this repository.
- You will need to get a Unity account (Student or Personal will suffice) and download Unity Hub.
- Install Unity 2019.4.17. The usual way to do this is through the Unity download archive, get that version of the installer.
- In the installer, specify that you want to be able to build for your current desktop platform (Windows/Mac/Linux) and if you want to build for mobile, a compatible mobile platform, only iOS and Android are supported.
- Open Unity Hub, click "Add", and navigate to where you cloned this repository, and select the "SecurityAR" folder. Select the Unity version to be 2019.4.17, and then open the project.
- Download the OpenCV For Unity package. In the Unity project, go to the top toolbar and click on "Assets", then "Import Package"-> "Custom Package". Select all the files and click import.
- Go to "Edit"->"Project Settings", search for unsafe, and check the box next to "Allow 'unsafe' Code", close this screen.
- If you are on Linux you will also have to launch all projects starting from Unity Hub with
LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/usr/lib64 unityhubin order for the camera to work with OpenCV For Unity
- If you are on Linux you will also have to launch all projects starting from Unity Hub with
- At the bottom portion of the screen, go down to "Project", and double click on the folder "Assets"->"Scenes" and then double click on the "Kitty - 1.1.unity" file.
Now the project is all set up.
If you click the play button at the top middle part of the screen you can view the app in real time.
If you wish to build the app, click on "File"->"Build" and then select your target platform and click "Build" or "Build and Run".
See current issues here. Our project board with tasks assigned and in their stages is here, and the actual and estimated times are listed here.
Our continuous integration server. We are using Unity CI. It is not working at this time due to a few issues:
Since we are using a library created by Enox Software called OpenCV for Unity to integrate OpenCV, we could not upload the assets with the library to our public Github repository for license issues. We could build the project locally with the assets. Additionally, we were unable to upload the unity “Library/” directory, which contains numerous binary files and is quite large in size (~400 MB for our project). The Library/ directory is actually git-ignored by convention (recommended in the official Unity .gitignore file) so we were surprised to see that it is actually required for the ci build process. This is a major issue we would need to solve in order to get ci working. Since we are lacking both the OpenCV library on the cloud, as well as the “Library” directory, we won’t be able to implement Continuous Integration with our public repository.
We will be following the Microsoft C# Coding Convention.
We use Github Super-Linter to check code practices in pull requests.
