Skip to content

Setup Unity Project

Info

It is advised to checkout the Quick Start Demo tutorial before reading this section.

This page is a tutorial for setting up a PAIRSIM Unity project.

Environment preparation

System setup

  1. Make sure your machine meets the required hardware specifications.
    • NOTE: PC requirements may vary depending on simulation contents which may change as the simulator develops
  2. Prepare a desktop PC with Ubuntu 22.04 installed.
  3. Install Nvidia drivers and Vulkan Graphics API.
  4. Install git.
  1. Make sure your machine meets the required hardware specifications.
    • NOTE: PC requirements may vary depending on simulation contents which may change as the simulator develops
  2. Prepare a desktop PC with Windows 10 or 11 (64 bit) installed.
  3. Install git.

Unity installation

Info

PAIRSIM's Unity version is currently 2021.3.45f1 LTS

Follow the steps below to install Unity on your machine:

  1. Install UnityHub to manage Unity projects. Please go to Unity download page and download latest UnityHub.AppImage.

  2. Install Unity 2021.3.45f1 LTS via UnityHub.

    • Open new terminal, navigate to directory where UnityHub.AppImage is download and execute the following command: 
      ./UnityHub.AppImage
    • To install Unity Editor please proceed as shown on the images below

    • At this point, your Unity installation process should have started.

      • *NOTE: If the installation process has not started after clicking the green button (image above), please copy the hyperlink (by rightclicking the button and selecting Copy link address) and add it as a argument for Unity Hub app. An example command: 
        ./UnityHub.AppImage unityhub://2021.1.7f1/d91830b65d9b

    • After successful installation the version will be available under the Installs tab in Unity Hub.

Open PAIRSIM project

To open the Unity PAIRSiM project in Unity Editor: 1. Make sure you have the PAIRSIM repository cloned 

git clone git@github.com:alvinye9/Purdue-AI-Racing-Simulator.git

  1. Launch UnityHub. 

    ./UnityHub.AppImage
    or 
    unityhub

  2. Open the project in UnityHub

    • Click the Open button

    • Navigate the directory where the PAIRSIM repository was cloned to

    • The project should be added to Projects tab in Unity Hub. To launch the project in Unity Editor simply click the Purdue-AI-Racing-Simulator item

    • The project is now ready to use

Warning

If you get the safe mode dialog when starting UnityEditor, you may need to install openssl.

  1. download libssl
    $ wget http://security.ubuntu.com/ubuntu/pool/main/o/openssl1.0/libssl1.0.0_1.0.2n-1ubuntu5.13_amd64.deb
  2. install
    sudo dpkg -i libssl1.0.0_1.0.2n-1ubuntu5.11_amd64.deb

Import external packages

To properly run and use PAIRSIM project in Unity it is required to download map package which is not included in the repository.

See instructions here

Info

All external prefabs imported as .unitypackage must be added to the .gitignore because the tracks have large file sizes and should not be directly uploaded to the repository.

Run the demo in Editor

The following steps describe how to run the demo in Unity Editor:

  1. Open the MenuScene.unity scene placed under Assets/Autonoma/Scenes directory
  2. Run the simulation by clicking Play button placed at the top section of Editor.
  3. The rest of the instructions are the same here