# Installation

Before you dive into the world of realvirtual.io, you'll need to set up your development environment correctly. Here's a step-by-step guide to get you started.

## realvirtual.io 6.3 (Unity 6.3 LTS)

{% hint style="success" %}
**Supported Unity Version**: realvirtual.io 6.3 requires **Unity 6.3 LTS** (version number **6000.3** in Unity Hub).
{% endhint %}

{% hint style="info" %}
Starting with version 6.3, realvirtual is distributed as **Unity Package Manager (UPM) packages** (`io.realvirtual.starter`, `io.realvirtual.professional`). The installation depends on where you purchased realvirtual — see Step 3 below.
{% endhint %}

{% hint style="info" %}
**Automatic Configuration**: For new installations, [Project Settings](https://doc.realvirtual.io/basics/project-settings) are applied automatically in the background to optimize your Unity project for industrial automation. For updates to existing projects, a dialog will appear asking if you want to apply these settings.
{% endhint %}

### Step 1: Install Unity 6.3 LTS

Install **Unity 6.3 LTS** through the Unity Hub. In Unity Hub, the version number is displayed as **6000.3** (e.g., 6000.3.5f1). For detailed instructions, refer to Unity's official installation guide.

{% embed url="<https://docs.unity3d.com/Manual/GettingStartedInstallingUnity.html>" %}
Unity 6 Installation guide
{% endembed %}

### Step 2: Create a New Unity Project

1. Open **Unity Hub** and click **New project**.
2. Select **Universal 3D** under Core templates to use the Universal Render Pipeline (URP).
3. Set a project name and choose a location for the project folder.
4. Ensure **Editor version 6000.3** (Unity 6.3 LTS) is selected.
5. Click **Create project**.

<figure><img src="https://260262196-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FpYxFg97YnJX96UzNNTSd%2Fuploads%2Fgit-blob-54db0272cae8aa261cd6a1fb9c35567d35afbb27%2Finstallation-63-new-project.png?alt=media" alt=""><figcaption><p>Creating a new Universal 3D project with Unity 6.3 LTS</p></figcaption></figure>

### Step 3: Install realvirtual Packages

The installation depends on where you purchased realvirtual. Choose the section that applies to you.

#### Purchased from the Unity Asset Store

1. Open **Window > Package Manager** in Unity.
2. Select **My Assets** in the left panel.
3. Find **realvirtual Starter** (and **realvirtual Professional** if purchased) and click **Download**.
4. After downloading, click **Import** to install the UPM packages into your project.

#### Purchased directly from realvirtual.io

For your first installation, download the `.tgz` package files from the **realvirtual Customer Portal**. The link and login credentials are provided on your invoice.

After downloading, install the packages in Unity:

1. Open **Window > Package Manager**.
2. Click the **+** button in the top-left corner and select **Install package from tarball...**.

<figure><img src="https://260262196-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FpYxFg97YnJX96UzNNTSd%2Fuploads%2Fgit-blob-bb40eef4a031da0e7a3ef65f885491f8c73a886a%2Finstallation-63-install-from-tarball.png?alt=media" alt="" width="375"><figcaption><p>Install package from tarball in Package Manager</p></figcaption></figure>

3. Navigate to the downloaded `.tgz` file and select **io.realvirtual.starter** first.

<figure><img src="https://260262196-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FpYxFg97YnJX96UzNNTSd%2Fuploads%2Fgit-blob-c060db95b20bda350bcc3d0866786a5b1bdfe853%2Finstallation-63-select-tarball.png?alt=media" alt=""><figcaption><p>Select the starter package tarball file</p></figcaption></figure>

4. Wait for the import to complete. This may take a few minutes.
5. Repeat the process for **io.realvirtual.professional** if you purchased the Professional edition.

<figure><img src="https://260262196-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FpYxFg97YnJX96UzNNTSd%2Fuploads%2Fgit-blob-c3b6876ca800bee3d771568c44a84ea8b421da87%2Finstallation-63-tarball-installed.png?alt=media" alt=""><figcaption><p>realvirtual Professional installed via tarball in Package Manager</p></figcaption></figure>

**Setting Up User Hub for Future Updates**

After installing the packages, the **realvirtual** menu appears in the Unity menu bar. Use the built-in **User Hub** to manage updates:

1. Go to **Tools > realvirtual > User Hub** in the Unity menu.

<figure><img src="https://260262196-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FpYxFg97YnJX96UzNNTSd%2Fuploads%2Fgit-blob-73510d99997ee56b8b3e067b9b2510fe7eaa94f1%2Finstallation-63-userhub-menu.png?alt=media" alt="" width="375"><figcaption><p>Open User Hub from the realvirtual menu</p></figcaption></figure>

2. In the **Login** tab, enter your **Invoice Number**, **Billing ZIP Code**, and **Email**. Click **Login**.

<figure><img src="https://260262196-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FpYxFg97YnJX96UzNNTSd%2Fuploads%2Fgit-blob-8cef3ec1ce637ca5298ddbf2dde4b3f0e2b5c0c9%2Finstallation-63-userhub-login.png?alt=media" alt="" width="375"><figcaption><p>User Hub login with invoice credentials</p></figcaption></figure>

**Activate UPM Registry (Recommended)**

To receive automatic update notifications, activate the realvirtual UPM Registry:

1. In User Hub, go to the **Packages** tab.
2. Click **Activate UPM Registry**.

<figure><img src="https://260262196-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FpYxFg97YnJX96UzNNTSd%2Fuploads%2Fgit-blob-8e3b4c636354ef2c4ab58b57e158a36e9667e102%2Finstallation-63-userhub-packages.png?alt=media" alt="" width="375"><figcaption><p>Activate UPM Registry in the Packages tab</p></figcaption></figure>

3. Unity will add a scoped registry to your **Project Settings > Package Manager** and show a confirmation dialog.

<figure><img src="https://260262196-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FpYxFg97YnJX96UzNNTSd%2Fuploads%2Fgit-blob-8b928afe385a79e33cbfcc9debb5071f29a48076%2Finstallation-63-scoped-registry-dialog.png?alt=media" alt=""><figcaption><p>Scoped registry added to Project Settings</p></figcaption></figure>

4. Future updates will now appear automatically in the Package Manager under **My Registries**. Use **Check for Updates** in User Hub to verify.

**Manual Updates via Tarball**

Alternatively, you can download newer versions from the **Downloads** tab in User Hub (or from the Customer Portal) and install them via **Install package from tarball** as described above.

<figure><img src="https://260262196-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FpYxFg97YnJX96UzNNTSd%2Fuploads%2Fgit-blob-ef0afcf1f6d56f5482b1c8d6257dc46572fba923%2Finstallation-63-userhub-downloads.png?alt=media" alt="" width="375"><figcaption><p>Download packages from the User Hub Downloads tab</p></figcaption></figure>

### Step 4: Handle Signature Warnings

{% hint style="warning" %}
When installing packages from the Customer Portal or User Hub (not from the Asset Store), Unity may show a **Missing Signature** or **Invalid Signature** warning. This is expected — realvirtual packages distributed outside the Asset Store are not Unity-signed. It is safe to click **Close** and continue.
{% endhint %}

<figure><img src="https://260262196-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FpYxFg97YnJX96UzNNTSd%2Fuploads%2Fgit-blob-f1e517ba925704e10092eedebd71a7361ee24a42%2Finstallation-63-missing-signature.png?alt=media" alt="" width="563"><figcaption><p>Missing Signature warning — safe to close</p></figcaption></figure>

<figure><img src="https://260262196-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FpYxFg97YnJX96UzNNTSd%2Fuploads%2Fgit-blob-27a689c67fba25c219882513b4bcb6fdb100207a%2Finstallation-63-invalid-signature.png?alt=media" alt="" width="375"><figcaption><p>Invalid Signature warning — safe to close</p></figcaption></figure>

### Step 5: Import Demo Scenes

After installation, a dialog will ask if you want to import the **Getting Started** demo scene. Click **Import Now** to get started right away.

<figure><img src="https://260262196-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FpYxFg97YnJX96UzNNTSd%2Fuploads%2Fgit-blob-789a124a79b20b608ae930c1a404b4dd0a891950%2Finstallation-63-demo-import-dialog.png?alt=media" alt="" width="375"><figcaption><p>Import the Getting Started demo scene</p></figcaption></figure>

You can import additional demo categories at any time using two methods:

**Via Package Manager:** Select **realvirtual Starter** (or Professional) in the Package Manager, go to the **Samples** tab, and click **Import** for the demo categories you want.

<figure><img src="https://260262196-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FpYxFg97YnJX96UzNNTSd%2Fuploads%2Fgit-blob-daa1cfff30545e7e0e6459ac5d12498fa7518d6a%2Finstallation-63-package-samples.png?alt=media" alt="" width="375"><figcaption><p>Import demo scene categories from the Samples tab</p></figcaption></figure>

**Via Demo Scenes Browser:** Go to **Tools > realvirtual > Demo Scenes Browser** in the Unity menu. This window shows all available demo scenes organized by category with descriptions.

<figure><img src="https://260262196-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FpYxFg97YnJX96UzNNTSd%2Fuploads%2Fgit-blob-b991e4925ffea2fcb740233821c3e6838e0ef601%2Finstallation-63-open-demo-menu.png?alt=media" alt="" width="375"><figcaption><p>Open Demo Scenes Browser from the realvirtual menu</p></figcaption></figure>

<figure><img src="https://260262196-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FpYxFg97YnJX96UzNNTSd%2Fuploads%2Fgit-blob-1dc2b31fb91f58a3a71072b03e1e6a4933852b6a%2Finstallation-63-demo-browser.png?alt=media" alt="" width="375"><figcaption><p>Demo Scenes Browser with categories and scene descriptions</p></figcaption></figure>

### Step 6: Explore the Demo Scene

The Getting Started demo scene opens automatically after import. It showcases a complete automation cell with conveyors, a robot, sensors, and a machine — all working together.

<figure><img src="https://260262196-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FpYxFg97YnJX96UzNNTSd%2Fuploads%2Fgit-blob-0b50d6ff6cd9afdf5502af2073722ec252484adc%2Finstallation-63-demo-scene.png?alt=media" alt=""><figcaption><p>realvirtual 6.3 demo scene</p></figcaption></figure>

Press **Play** in the Unity Editor to start the simulation and see the automation in action.

### Possible Problems and Fixes

#### Wrong Input System

If you see red error messages in the **Console** related to the Input System, make sure that the **Active Input Handling** in **Project Settings > Player > Configuration** is set to **Both (old and new Input System)**.

#### Wrong Render Pipeline

If your demo scene appears pink, you may be using the wrong render pipeline. We recommend switching to the **Universal Render Pipeline (URP)**. See [Render Pipelines](https://doc.realvirtual.io/advanced-topics/render-pipelines) for details.

#### TextMesh Pro Essentials Not Imported

If you encounter problems with text in the Runtime UI, go to **Window > TextMeshPro > Import TMP Essential Resources** to install the required components.

### (Optional) Clean Up Unnecessary Unity Demo Folders

To keep your project clean, you can delete Unity's default demo assets if present:

* **Scenes**
* **Settings**
* **TutorialInfo**

***

## Upgrading from realvirtual 6.0 to 6.3

If you have an existing project using **realvirtual 6.0.x** (the `.unitypackage` version), follow these steps to migrate to the new UPM package format.

{% hint style="warning" %}
**Important: Two-Step Process** — First upgrade Unity, then upgrade realvirtual. Do not attempt both simultaneously.
{% endhint %}

### Step 1: Upgrade Unity to 6.3 LTS

1. Open **Unity Hub** and change the **Editor Version** of your project to **6000.3** (Unity 6.3 LTS).
2. Accept any compatibility warnings and let Unity convert your project.

### Step 2: Remove the old realvirtual folder

1. **Close Unity** completely.
2. Delete the **Assets/realvirtual** folder from your project directory (this is the old `.unitypackage` content).
3. Delete the **Library** folder to force Unity to regenerate all cached metadata.

{% hint style="info" %}
**Don't worry about references!** All references in your scenes and prefabs are preserved. Unity maintains them through GUIDs, even when folders are deleted and reimported from a different location.
{% endhint %}

### Step 3: Install the UPM packages

1. Reopen your project in Unity 6.3 LTS. You will see compilation errors — this is expected.
2. Install the new UPM packages following **Step 3** from the [installation instructions above](#step-3-install-realvirtual-packages) (either via Asset Store or Customer Portal tarball).
3. After the packages are installed, compilation errors should be resolved.

### Step 4: Verify the upgrade

1. Check the **Console** window for any remaining errors.
2. Open one of your scenes and verify that all components, references, and materials are intact.
3. If materials appear pink, go to **Tools > realvirtual > Settings > Switch to Universal Render Pipeline (URP)** to convert them.

{% hint style="success" %}
After upgrading, you can use the [User Hub](#setting-up-user-hub-for-future-updates) to set up the UPM Registry for future automatic updates.
{% endhint %}

***

## realvirtual.io 6.0 (Unity 6 — .unitypackage)

{% hint style="warning" %}
This section covers the **legacy .unitypackage** installation for realvirtual 6.0.x. For version 6.3 and later, follow the UPM instructions above.
{% endhint %}

{% embed url="<https://youtu.be/KT8qJ8BOJaQ?si=kq-St2-Nccp6uV83>" %}
Tutorial realvirtual.io 6 and Unity 6 Installation
{% endembed %}

### Step 1: Install Unity 6 LTS

Install **Unity 6000.0 LTS** (Unity 6) through the Unity Hub.

### Step 2: Create a New Unity Project

1. Open **Unity Hub**.
2. Select **Universal 3D** under Core templates.
3. Ensure **Editor version 6000.0 LTS** is selected.
4. Click **Create Project**.

<figure><img src="https://260262196-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FpYxFg97YnJX96UzNNTSd%2Fuploads%2Fgit-blob-7f9bc46bc5ed77360ef716645a48fe9856e775e2%2FInstallation-newProject.png?alt=media" alt=""><figcaption></figcaption></figure>

### Step 3: Install realvirtual.io 6

* **Direct Purchase from realvirtual.io**:
  1. Download the `realvirtual.unitypackage` file from your account on the realvirtual.io download website.
  2. Drag and drop the file into the Unity Project window, or go to **Assets > Import Package > Custom Package**.
* **Unity Asset Store**:
  1. Open **Window > Package Manager**.
  2. Under **My Assets**, locate **realvirtual.io 6** and click **Download**, then **Import**.

When prompted about a **URP Upgrade**, select **Install / Upgrade**.

<figure><img src="https://260262196-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FpYxFg97YnJX96UzNNTSd%2Fuploads%2Fgit-blob-5a72021d0f1b464a6ba6906db5c3dfac8c3b1fcd%2Finstall-urpupgrade.png?alt=media" alt="" width="375"><figcaption><p>Installation Warning</p></figcaption></figure>

<figure><img src="https://260262196-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FpYxFg97YnJX96UzNNTSd%2Fuploads%2Fgit-blob-e87183ff606eb345d04431bc16ae88aee5c6591c%2Finstall-importpackage.png?alt=media" alt="" width="375"><figcaption><p>Import Unity Package</p></figcaption></figure>

After import, the demo scene opens automatically.

<figure><img src="https://260262196-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FpYxFg97YnJX96UzNNTSd%2Fuploads%2Fgit-blob-dd18d60e9a1033dd6428b866d2850d9b1d28c49d%2Fnewdemo.gif?alt=media" alt=""><figcaption><p>Demo scene after installation</p></figcaption></figure>

### Possible Problems and Fixes

See the [problems and fixes section above](#possible-problems-and-fixes) — the same issues and solutions apply.

***

## realvirtual.io 2022 and before

### 1. Install Unity

If you haven't already, install Unity on your computer. Unity offers both free and licensed versions, depending on your use case. Check Unity's official website [here](https://store.unity.com/) to determine which version suits your needs.

{% embed url="<https://youtu.be/Pn4QTBucbMM?si=tzLTmVYkzQFEgIno>" %}
Installation of realvirtual.io 2022 (old deprecated version)
{% endembed %}

> Our new releases is always based on the latest Unity Long Term stable release. Our main version number (e.g. 6) always corresponds to the Unity version number. For example to run realvirtual.io 2022.09 you need Unity 2022.03 LTS.

### 2. Unity Hub (Recommended)

We highly recommend installing Unity Hub, a tool that simplifies managing multiple projects and Unity installations. You can download Unity Hub from Unity's official download pages.

### 3. Create a New Project

Launch Unity and create a new empty project by selecting "New." Choose a location on your computer to store your project files and give your project a name. Then, click "Create Project."

When prompted to choose a template, select the standard 3D template. This will form the foundation of your project:

<figure><img src="https://260262196-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FpYxFg97YnJX96UzNNTSd%2Fuploads%2Fgit-blob-fe777a59b6dd55d560f4a18c855d01ffa157347a%2Fimage.png?alt=media" alt=""><figcaption><p>Creating a new Unity Project with the Unity Hub</p></figcaption></figure>

### 5. Ensure .Net Standard Framework 2.1 and Mono are Enabled

By default, Unity should have .Net Standard 2.1 and Mono enabled. However, in some cases, especially when integrating realvirtual.io into an older project, this setting might be incorrect. To confirm or change this setting:

* Go to Player Settings by selecting "Build Settings" > "Player Settings."
* Under "Configuration," change the Scripting Runtime Version to ".NET Standard 2.1"

For the scripting backend, it's recommended to start with Mono rather than IL2CPP, as Mono typically compiles much faster.

<figure><img src="https://260262196-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FpYxFg97YnJX96UzNNTSd%2Fuploads%2Fgit-blob-503dd0823df2acbfab0055ce9d8c798cb067fb95%2Fplayer-netframework.png?alt=media" alt=""><figcaption><p>Selecting the .Net Standard 2.1 in the Unity Player Project Settings</p></figcaption></figure>

### 6. Acquire realvirtual.io

Go to the Unity Asset Store and purchase the version of realvirtual.io that suits your needs, whether it's Lite or Professional.

### 7. Import realvirtual.io

You can import realvirtual.io directly from the Unity Asset Store or manually download the asset. To install it manually, follow these steps:

* From the main menu, go to "Assets" > "Import Package" > "Custom Package..."
* A new window will appear, displaying the contents of the realvirtual.io package. Select "All" and click "Import."

<figure><img src="https://260262196-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FpYxFg97YnJX96UzNNTSd%2Fuploads%2Fgit-blob-9410061ed400408879b9571fbc9365ca4a23f8e9%2Fimage%20(10).png?alt=media" alt=""><figcaption><p>Import custom package</p></figcaption></figure>

This will show a new window with all the realvirtual.io package contents:

![](https://260262196-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FpYxFg97YnJX96UzNNTSd%2Fuploads%2Fgit-blob-58509931e3b0c11cb2c6cbdcf613755a36cac7b4%2Fimage.png?alt=media)

Please select *All* and *Import*.

### 8. Verify Installation

After importing the realvirtual.io package, check for the following:

* You should see an additional "realvirtual" folder (previously "game4automation" before 2022) in your project structure.
* A new "realvirtual" menu should be available in the main menu bar.

<figure><img src="https://260262196-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FpYxFg97YnJX96UzNNTSd%2Fuploads%2Fgit-blob-a178ea87b555df407bed026aeee002055f32c2a3%2Fdemoscene.png?alt=media" alt=""><figcaption><p>Project view after realvirtual.io installation</p></figcaption></figure>

### 9. Set Standard Settings

{% hint style="info" %}
Usually, standard settings are applied automatically after a fresh installation or update of realvirtual.io. However, if you encounter compile errors in the console window, it may be due to conflicts between your existing project assets and realvirtual.io.
{% endhint %}

In such cases:

* Address the compile errors first to ensure there are none remaining.
* Once errors are resolved, apply the standard settings by selecting "realvirtual" > "Apply Standard Settings" from the main menu.

<img src="https://260262196-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FpYxFg97YnJX96UzNNTSd%2Fuploads%2Fgit-blob-85f2b8a08278553f52bd51bc79ea5391d4a358de%2FapplyStandardSetting.png?alt=media" alt="" data-size="original">

Applying standard settings will configure:

* Standard layer naming (for physics).
* Standard physics collision matrix.
* Standard light settings.

Congratulations! You've now completed the installation process and are ready to explore the Demomodel outlined in the documentation.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://doc.realvirtual.io/basics/installation.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
