VIM API for Unity

Get started! VIMs to load into 3D Unity runtimes

VIM avatar
Written by VIM
Updated over a week ago

Take advantage of live VIM file loading with well-tessellated meshes from Revit and IFC. This approach avoids one-off real-time experiences, which require artists and developers to build unique apps per BIM project.

VIM API for Unity

This package looks at the VIM API for quickly loading optimized Unity scenes from VIM files.


There are two packages available:

  1. which uses VIM 1.0.xx series for Unity 2019.4.14f1

  2. or newer which uses VIM 1.2.00-1.2.72 for Unity 2022.2.0b5



Importing VIM API using Unity's Package Manager

  1. Download and unzip this package

  2. Create a new 3D unity project, or use your own.

  3. In the top navigation bar, go open "Window > Package Manager."

  4. In the top-left corner of the Package Manager, click on the "+" menu item to load a new package and select "Add package from disk."

  5. Navigate to find where you unzipped this package. Then select "package.json" and click "Open."


Running Sample Scene

  1. In the Package Manager's top left menu, in the dropdown on the right side of the "+" sign, select "In Project" instead of "Unity Registry" or other values.

  2. At the top of the list, under the "Custom" section, Select the "Vim.Unity.Api"

  3. In the bottom right side panel, under "Samples," click "Import" next to "LoadVim."

  4. In the Project Browser, you can now run and open the sample scene "...\Assets\Samples\VIM Unity API\0.3.0\LoadVim\Scenes\Sample_LoadVim.unity."

Exploring Sample Code and Project

  1. Select the "Loader" in the Hierarchy Panel

  2. In the Inspector, under the "Sample Loader (Script)," you can select one of the VIM model sample files to load different VIMs.

  3. To load your own VIM file, enter the path to your file in the input for "Custom Path." You can create your own VIM files using our Revit exporter or IFC to VIM conversion process.

  4. Once you have selected the VIM model, press "Play."

VIM Auto-import

  1. Unity will automatically find and import any vim file you place into the project folder.

  2. The newly created asset will have a vim icon.

  3. You can reference the asset in the SampleLoader to load it.

Did this answer your question?