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 AWSIM 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

AWSIM's Unity version is currently 2021.1.7f1

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.1.7f1 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 AWSIM project

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

git clone git@github.com:tier4/AWSIM.git

  1. Launch UnityHub. 

    ./UnityHub.AppImage

  2. Open the project in UnityHub

    • Click the Open button

    • Navigate the directory where the AWSIM 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 AWSIM 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.13_amd64.deb

Import external packages

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

  1. Download and import Japan_Tokyo_Nishishinjuku.unitypackage

    Download Map files (unitypackage)

  2. In Unity Editor, from the menu bar at the top, select Assets -> Import Package -> Custom Package... and navigate the Japan_Tokyo_Nishishinjuku.unitypackage file.

  3. Nishishinjuku package has been successfully imported under Assets/AWSIM/Externals/directory.

Info

The Externals directory is added to the .gitignore because the map has a large file size 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 AutowareSimulation.unity scene placed under Assets/AWSIM/Scenes/Main directory
  2. Run the simulation by clicking Play button placed at the top section of Editor.