- Visit the Headjack Template Marketplace and pick one of the “Essential” templates that most closely matches your use case.
- Use the “Generate Unity package” option to download your selected template.
- Extract the template .zip package anywhere on your computer.
- (Install and) open Unity Hub (preferably on Windows) and install Unity 2019.4.12f1 (LTS). Select the “Android Build Support” (including optional components) and/or “iOS Build Support” optional modules if you want to build and test locally for those platforms.
- Under “Projects”, click “ADD” and navigate to where you extracted the template, then click “Select Folder” to add the template package to your Projects list.
- Now click the newly added project and wait for your project to open and import in Unity.
- Open the Headjack Settings menu with the Headjack > Settings menu option at the top of the Unity Editor. The Headjack Settings window should appear over top of the Unity Editor.
- Back in the Headjack CMS, go to your App page and at the bottom expand the “Advanced” section.
- Copy the App ID and the AUTH Key from that Advanced section to their respective fields in the Headjack Settings window in Unity.
- There are two methods to preview the template and your app contents in the Unity Editor, depending on whether you have a VR headset attached to your PC:
- If you don’t have a VR headset attached to your PC, select “Cardboard” as the Virtual Reality API in Headjack Settings
- If you have a VR headset attached to your PC, select “Oculus” (if it is an Oculus headset) or “Open VR” (if it any other PC VR headset) as the Virtual Reality API in Headjack Settings
- Don’t worry about what is selected as the “VR Device” in Headjack Settings as it does not matter if this does not match your headset exactly.
- Click the “Apply Settings” button at the bottom of Headjack Settings to save your changes and wait a few seconds for Unity to finish loading those changes.
- In the Project file browser in Unity, navigate to the “Template” folder and double click the “App” scene file to open the initial scene of the template in the Editor.
- Now click the play button at the top of the Unity Editor to preview your app. You may have to switch to the “Game” tab in Unity to view your app in action. The projects you added to your app in the Headjack CMS should appear in the menu, ready to be previewed.
- Depending on your selected Virtual Reality API, you can now interact with your app:
- If you decided not to use a connected VR headset and selected “Cardboard”, hold the left ALT key and move your mouse to look around your app menu. Use left mouse click to select menu items and use the Backspace key to go back to the previous menu. If applicable, use the arrow keys to scroll through the menu.
- If you decided to use a connected VR headset and selected either “Oculus” or “Open VR”, put on the headset and use the VR controller(s) to interact with your app as normal.
- Congratulations, you have a working Unity project with Headjack SDK and pre-made template, ready to be customized.
- Next up: how to build your custom app locally for different VR platforms and how to export your custom template for use with Headjack Cloud Build.
What Unity version should I be using?
Do I need to install additional SDK’s or Software packages?
Can I use the content stored in the Headjack CMS during my development?
Where do I download the Headjack Plug-in/SDK
Which VR platforms do the SDK support?
What do I use the “App ID” and the “Auth Key” for?
What is the Bundle ID?