Forma installation

Unity Forma is a package that runs with the Unity Industrial Collection (UIC). UIC includes Unity Pro, Pixyz Plugin for Unity, AxF, and xTex material importers.

License information

Before you can use Unity Forma, you must have a valid license for both UIC and Unity Forma.

For information on getting a subscription for your organization, refer to the Industrial Applications section on the Products page.

  • Node-locked licenses: If your organization purchased node-locked licenses for Unity Forma, your Unity ID must be assigned to one of the seats for the node-locked license. If your Unity ID isn't assigned a seat, the Unity Forma package isn't available in the Package Manager. To find out whether your Unity ID is assigned a Unity Forma seat, contact your system administrator.

  • Floating licenses: If your organization purchased a Floating license for Unity Forma, the Unity Forma package appears in the Package Manager for you to install. If other users in your organization are working with Unity Forma, you may not be able to use it until a license in your pool becomes available. For more information, contact your system administrator.

Install Unity Forma

Unity Forma includes several packages with dependencies and sample assets. You can install Unity Forma using either the Unity Forma installer or Package Manager. For convenience, install it using the Unity Forma installer.

Install Unity Forma using the installer

The Unity Forma installer provides you with the following:

Component Description Automatic or optional installation
Unity Hub Installs the Unity Hub if it's not already installed. Automatic
Forma sample project Installs the Unity Forma sample project. Optional
Unity Editor 2021.3.19f1 Installs the 2021.3.19f1 version of the Unity Editor, which supports the following builds:
  • Android
  • iOS
  • WebGL
 Optional
Templates Installs the following templates, which are supported on the Unity Editor 2021.3.19f1 and later:
  • Forma URP template
  • Forma HDRP template
 Optional
Sample packages Installs the following packages:
  • Aviera product
  • Measured Materials library
  • Basic White stage
  • Industrial Showroom stage
  • Futuristic Asia stage
  • Luxury Showroom stage
  • Salt Lake stage
 Optional

To install Unity Forma, follow these steps:

  1. Select the link to the Unity Forma installer that you received from Unity.
  2. Run the executable link.
  3. Accept the End User License Agreement.
  4. In the Select Components window, select the components you want to install (refer to the previous table).
  5. Select Next.
  6. Select where you want to install the chosen components.
  7. The installer installs the selected components. You can now open the Unity Forma installer README.txt file and begin using Unity Forma in the Unity Editor.

Install Unity Forma using the Package Manager

Installing through the Package Manager provides you with the Unity Forma package. Advanced users can install specific components from the Package Manager.

To install Unity Forma, follow these steps:

  1. Go to Window > Package Manager in your Unity project.
  2. Select Packages: Unity Registry.
  3. Search for Unity Forma.
  4. Select Install.
  5. Confirm that the Unity Forma package is listed in the Packages: In Project menu.

Activate your License

Before you can open Unity Forma, you must activate your Unity license.

  1. Open the Unity Hub.
  2. If not already logged in, go to Profile > Sign in and sign in with your Unity ID.
  3. Go to Preferences > Licenses.
  4. Select Add.
  5. Select the activation method that applies and follow the instructions to activate your Unity license.

Open a sample project

Note: This section applies only if you installed Unity Forma using the Unity Forma installer.

Your installation includes two sample projects. One for Universal Render Pipeline (URP) assets and another for High Definition Render Pipeline (HDRP) assets. To open a sample project, follow these steps:

  1. Select Projects in the Unity Hub.
  2. Go to Open > Add project from disk and navigate to the folder that contains the Unity Forma sample projects. By default, the sample projects are installed in C:\Users\[Your_User_Name]\unity-forma-sample-project-4.x.y on Windows and in /Users/[Your_User_Name]/unity-forma-sample-project-4.x.y on macOS.
  3. Select the folder for the sample project you want to open (SampleProject-HDRP or SampleProject-URP), and then select Add Project. The Unity Hub adds and displays the project.
  4. To open the project, select it in the Unity Hub. It can take several minutes for the Unity Editor to import the sample project the first time you open it.

Create a Forma project using a template

Note: This section applies only if you installed the templates using the Unity Forma installer.

Your installation includes two templates, one with URP and one with HDRP. To use a template, follow these steps:

  1. Select New project in the Unity Hub.
  2. Select your Unity Editor version from the Editor Version dropdown. Forma templates aren't available on all Unity Editor versions.

  3. In the All templates section, select either Forma (HDRP) or Forma (URP).

    Note: If the templates aren't visible, you might need to quit and then restart the Unity Hub.

  4. Update the Project name and Location settings.

    Note: The path in the Location setting must be short. If the path is too long, the following error message appears: Failed to resolve project template: Failed to decompress <path>.

  5. Select Create project.

Helpful resources for getting started

For information on adding Unity Forma from the Unity Hub and getting started, refer to the Unity Resources Portal video on Installing Unity Forma.

Pixyz plugin

The Pixyz Plugin package lets you import various file formats that you save in Pixyz to the Unity Editor.

If you use the Unity Forma Sample Project or Template Project to create your configurator, the Pixyz Plugin is installed automatically when you import the project.

Pixyz package installation

If you want to import a product from Pixyz into a different project, you must add the package to the project from the Package Manager.

When installed, a Pixyz menu appears on the menu bar of the Editor. The menu allows you to connect to the Pixyz License Manager to add your Pixyz license.

For more information about Pixyz licensing, refer to: https://www.pixyz-software.com/documentations/html/2022.1/plugin4unity/Licensing.html.

Forma Compatibility

The following table lists the Unity versions that are compatible with Forma Editor features.

2020.3 2021.3 Windows Mac Included in installer 4.0.2 Included in installer 4.3.2
Forma
Forma 4.3 ✓ ✓ ✓ 4.3.2
Forma 4.1 ✓ ✓ ✓ ✓
Forma 4.0 ✓ ✓ ✓ ✓ 4.0.2
Templates
Template HDRP ✓ ✓ ✓ 2021.3.4f1 2021.3.19f1
Template URP ✓ ✓ ✓ 2021.3.4f1 2021.3.19f1
Samples
Sample Project HDRP 2021.3.4f1 ✓ ✓ 2021.3.4f1 2021.3.19f1
Sample Project URP 2021.3.4f1 ✓ ✓ 2021.3.4f1 2021.3.19f1
Aviera Product ✓ ✓ ✓ ✓ ✓ ✓
Measured Materials Library ✓ ✓ ✓ ✓ ✓ ✓
Sample Importer (csv) ✓ ✓ ✓ ✓ ✓ ✓
Stages
Basic White ✓ ✓ ✓ ✓ ✓ ✓
Industrial Showroom ✓ ✓ ✓ ✓ ✓ ✓
Futuristic Asia ✓ ✓ ✓ ✓ ✓ ✓
Luxury Showroom ✓ ✓ ✓ ✓ ✓ ✓
Salt Lake ✓ ✓ ✓ ✓ ✓ ✓