> For the complete documentation index, see [llms.txt](https://crizgames.gitbook.io/vour/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://crizgames.gitbook.io/vour/getting-started.md).

# Getting Started

## 1. What is Vour?

[Vour](http://u3d.as/2kQ2) is an asset for the [Unity game engine](https://unity.com/). It helps you with creating virtual tours with images/videos in 2D, 3D, 180°, 180° 3D, 360°, 360° 3D and in 3D environments. 

## 2. Project Setup

It is strongly recommended to use the [Universal Render Pipeline](https://docs.unity3d.com/Manual/urp/urp-introduction.html) (URP) for your project by using the `Universal 3D` project template. URP is better supported than the Built-in Render Pipeline and is **required** for WebXR.

To get started, simply import Vour. A setup window will appear, prompting you to install the necessary dependencies. If prompted about the new input system, select *Yes*. 

If you encounter prefab import errors for `OpenXR Player` and `WebXR Player`, you can safely ignore them. These assets will be imported correctly once VR support is installed.

{% hint style="info" %}
You can later access the setup window for installing additional feature via the top-left menu: **Vou**r → **Setup**.
{% endhint %}

<div align="left"><figure><img src="/files/4atqTE7PWY8cEZBbmcMQ" alt=""><figcaption><p>1. Install dependencies</p></figcaption></figure> <figure><img src="/files/FINgbEFpm7HPOnmDt9C1" alt=""><figcaption><p>2. Install optional features</p></figcaption></figure> <figure><img src="/files/zBHcV7pjKpdqQVczhrxI" alt=""><figcaption><p>3. Enable installed features</p></figcaption></figure></div>

## 2.1. Adding VR Support

To add VR support for various platforms, you can install and enable them in the setup window under "[Optional Features](/vour/optional-features.md)".

Vour utilizes OpenXR, ensuring compatibility with all major VR headsets (e.g. Meta Quest, Valve Index). WebXR is also supported.

{% hint style="info" %}
Due to a limitation of Unity's OpenXR package, it is not possible to automatically load the right controllers for each headset. Controller models have to be added manually for now.  \
For more info: [Add Custom VR Controller Models](/vour/add-custom-vr-controller-models.md)
{% endhint %}

## 3. Create a Tour

First, we need to setup the scene. Use either the `Vour Basic` scene template via **File** → **New Scene** or:

1. Create a new scene.
2. Delete `Main Camera`.
3. Create a `Location Manager` via **GameObject** → **Vour** → **Location Manager**.
4. Create a `Player` via **GameObject** → **Vour** → **Player**.

Now we are ready to create a small tour.

1. Create a location of your choice via **GameObject** → **Vour** → **Location**.
2. Assign the image or video to it, and change the other settings as you need to.
3. With the location game object selected, click `Add Teleport Point` in the inspector and position the `Teleport Point`.
4. Create another location and set it up like in steps 1 & 2.
5. Now go back to the `Teleport Point` and drag the second location into `Target Location` field. Now you can teleport from the first location to the second. If you want to teleport back, create a `Teleport Point` at the second location and assign the first location as its `Target Location`.
6. Select the `Location Manager` and drag the first location into the `Start Location` field.

Done! You should now be able to explore the locations in play mode.

For more information on how a tour can be built, please take a look at the "DemoTour" scene located at `Assets/Vour/Sample`*.*

{% embed url="<https://www.youtube.com/watch?v=U1_KJgW9mME>" %}