Getting Started

Getting Started

This document should be the first to be read when creating a new project using ExPresS XR.  

Here, you will find:

• A list of required software and how to install it
• An introduction to how to set up your project
• An explanation of the project's structure
• A guide for the next steps after the setup

Project Setup

The project files need to be downloaded and added to Unity. As the ExPresS XR-Repository is configured as a template, new repositories can easily be created:

1. Log in at the Github Website and locate the ExPresS XR-Repository.

2. Click the green Button "Use this template", enter a "Repository Name", set its visibility to "private" and press the green button "Create repository from template". This will create a new repository as an exact copy of the main-Branch of the ExPresS XR-Repository.

3. Then, using your account, log in to GitHub Desktop, go to "File > Clone repository ...", select your newly created repository from the list and press clone.

4. Press the "Fetch"-Button in the top bar and download the repository. This might take a while.

5. Then go to Unity Hub, press the "Open"-Button and locate the root folder of your cloned repository. Import it by pressing the "Open"-Button of the explorer. In case Unity warns about any errors, don't worry; you are just missing some packages. Do not enter "Safe Mode" but hit "Ignore" and proceed with installing the packages. In Unity, go to "Window > Package Manager" and install and update all installed packages if necessary. You will find a full list of the packages along with the required versions here.
   When using VS Code, make sure that the "Visual Studio Code Editor"-Package is installed.

Note: If you decide not to use Git (big mistake:D) you can simply download the files by pressing the "Code" button of the ExPresS XR-Repository and then selecting "Download ZIP".

Project Structure

Most GameObjects and Components of ExPresS XR can be created/added as normal via the GameObject-Menu.

Some additional features and tutorials are provided via the "ExPresS XR"-Menu, including Setup Dialogs for a new project and the TutorialButtonQuiz.

The template project comes with a few empty folders in the "/Asset/"-Folder for structuring your files and the other files are nicely tucked away. All files of ExPresS XR are contained in the "/Asset/ExPresS XR/"-Folder. In which you find a similar structure as in "/Asset/" itself (Order is key:D).  

Do not change or move files inside the "/Asset/ExPresS XR/"-Folder!   You can use or copy stuff like materials or models from "/Asset/ExPresS XR/" to "/Asset/" as you desire.

Next Steps

Depending on your project's aim, you might want to check out:

• The "Initial Setup"-Dialog in the Unity Editor at ExPresS XR/Initial Setup to create your own custom XR Rig and launch a custom scene for you to try out ExPresS XRs features.
  This is great if you don't know where to start.
• The ready-to-play sample scenes, located at /Assets/ExPresS XR/Scenes/....
• Make sure to take a look at Reserved Resources if you are planning on expanding the features of this project.
• Check out the Tips And Best Practices.
• Check out the Setup Dialogs to get a head start on your project.
• More workflow tutorials, like for Converting Real-World Objects to 3D Models and how to import them.
• The ExPresS XR Rig and the Tutorial Button Quiz Game Object and their documentation.