/IllbeHomeforChristmas

My Capstone project created for the Udacity VR Developer Nanodegree.

Primary LanguageC#

I'll be Home for Christmas

An example video of this application built and running on device can be found on my YouTube Channel.

This repository contains a Unity mobile application for iOS and Android devices called I'll be Home for Christmas. It was built and tested using the Google Cardboard Viewer. The application is a maze game where the user must complete the maze in order to win and be prompted to restart the game. Along the way, the user is able to collect items to increase their score to add to the fun of the experience! This was my capstone project for the Udacity VR Developer Nanodegree Program. The experience is designed to make the user feel the emotion of Joy as they play. The project presents my skills and what I learned while developing mobile applications during the Udacity course.
screen shot 2018-02-09 a 1 09 25 pm

Getting Started

Prerequisites

The software you will need to download in order to build and run the game on a mobile device:

• The cross-platform engine Unity Patch Release 2017.1.0p4.

  • For iOS builds, the latest version of Xcode.
  • NOTE! You will need to have an Apple ID in order to download Xcode and build for iOS.
  • NOTE! Make sure to have the latest software version; 11 and up.
  • For Android builds, you need Android Studio and the Java JDK 8.

Installing

To build and run a copy of this application to your mobile device:

• On the I'll be Home for Christmas repository, go to the green "Clone or download" button and click "Download Zip".

• Once the zip file has loaded onto your desktop, double click the zip file to open. Navigate to the folder Assets > ChristmasMaze.unity and double click the scene to open it in Unity.

-NOTE! The scene may not be located at the top of the folder. If not, you will have to scroll through the folder to find it. It will be titled exactly ChristmasMaze.unity with the Unity logo-

After opening the scene in Unity choose to build to either an iOS or Android mobile device:

  1. For iOS builds:
    • Go to File > Build Settings and switch the platform to iOS (this can take a while) then click the Player Settings button below that and with this open you can change the name of the application and bundle identifier, if you would like to change them, before pressing Build and Run to then be prompted to name the build and save it. (I usually save the build to my desktop so I can delete it later)
      • The build will open in Xcode. Make sure to check your Apple ID is correct, the bundle identifier and the name of the application is what you would like it to be then press the play button in the upper left corner and the application will build and run directly to your iOS device.
  2. For Android builds:
    • First, go to the top left corner and click Unity > Preferences. Then, select External Tools in the list and add the locations of Android Studio and Java JDK 8 in the correct section.
      • Afterwards, go to File > Build Settings and switch platform to Android (this can take a while to do) then click the Player Settings button below that and you can change the name of the application and bundle identifier, if you would like to change them, before pressing Build and Run to then be prompted to name the build and save it. The application will be built right to your Android device from Unity.

Deployment

When building the application to your phone a few important things to note:

• In Player Settings, you are able to not only change the name of the application and bundle identifier to whatever you would like you can also add a photo to be the icon for the application on your phone. It will be one of the first things you can do in Player Settings. Right under renaming the application.
• The Google VR SDK used in the game tracks your head movement. Meaning, wherever the phone is facing, the application will open and start your game from that position. If you would like to be facing a certain direction to play the game right after building to your phone I would suggest facing your device in that direction and hold it horizontally so you can start the experience in the most comfortable position for you.

How to play

The instructions to play the application I'll be Home for Christmas are very simple and fun! screen shot 2018-02-09 at 1 11 41 pm

• After beginning the game, press the "Begin!" button on the panel in front of you.

• You can move throughout the maze by clicking on the spherical waypoints with the viewer clicker. The waypoints will change from red to green as you gaze on them.

• While going through the maze you can pick up any presents or stars you see to increase your score. Keep an eye out for the stars, they are worth more points. Also, there will be a point where user must pick up trash on ground to help save the Earth. Would be a good idea to pick these up, as it is the right thing to do, but you will also get more points after doing so

• After reaching the end of the maze you can restart the experience by clicking the "Restart" button you will see while entering the house as you have finally made it home for Christmas!

screen shot 2018-02-09 at 1 13 56 pm

Authors

• Samantha Cayla Bajis - Initial work - SamBajis

Acknowledgments

To make I'll be Home for Christmas possible:

• Udacity - Coding for player movement mechanic

• Google VR SDK- Head tracking, sound system and ability for the users interaction with the Google Cardboard Viewer

• Blender- Created cans, trash, and box the user will pick up towards the end of the experience using the 3D computer graphics software Blender

• Bretwalda Games - They created the Christmas 3D models used in experience. Such as the stars, presents and tree