Zimension Docs

Unity porting overview

Understand the Zimension-to-Unity ZIP workflow, native conversion, output folders and the difference between the template and your project export.

Native conversion · importer 0.3.11

Start with the import walkthrough

The Unity workflow page has the project download, illustrated setup steps and FAQs. Download and unzip the reusable Unity project, open it through Unity Hub, then import the ZIP exported from your own Zimension project using Zimension > Import from Zimension > From a file.

The project export and the Unity template are different files. The current walkthrough uses Zimension's Web project export ZIP; it does not require a dedicated Unity export link.

What the native converter creates

The default import mode converts supported features into ordinary Unity scenes, GameObjects, Kit components, Animator Controllers, AudioSources, Terrain and readable C# logic. It does not run the browser's JavaScript in Unity.

The package also contains an older interpreting runtime. Its compatibility differs from native conversion. This documentation describes the default native workflow; do not use the older runtime's feature list as a promise about native conversion.

Import to first play

  1. Save the Zimension project and export a Web project ZIP with all required assets. Keep this project ZIP compressed.
  2. Download ZimensionUnity-0.3.11.zip. On Windows, right-click it and choose Extract All… > Extract. On macOS, double-click it to extract.
  3. Open Unity Hub and click Projects > Add > Add project from disk. Select the extracted ZimensionUnity folder that directly contains Assets, Packages and ProjectSettings. If there is a versioned outer folder, open it first. Confirm with Select Folder or Open; do not select Assets, Packages or ProjectSettings individually.
  4. Click the added ZimensionUnity project in Unity Hub, open with Unity 6 and wait for package installation and initial setup.
  5. In the Unity Editor menu bar, choose Zimension > Import from Zimension. Click From a file, click Zip… next to Export, select your project export ZIP from the first step and click Open, then Import. Do not select the Unity template ZIP.
  6. Allow model import, retargeting, C# compilation and scene wiring to finish. The Console should report Connected <Project>Logic in <scene>.
  7. Open the base scene, press Unity's Play button and click Play on the game's start screen.
  8. Review Assets/Zimension/Generated/<Project>/export-report.json and test the features your project uses.

Version and validation

This documentation targets importer 0.3.3 and Unity Editor 6000.6.8f1. Use the exact editor recorded in the template's ProjectSettings/ProjectVersion.txt so Unity Hub, package dependencies and the release checks agree. Focused checks using a real exported avatar and rifle, plus vehicle exit and attachment checks, passed in Unity 6000.6.8f1 on Windows.

Those checks do not establish that every project, rig or target platform is supported. Review the feature matrix and test your own project in Play mode and in a standalone build.

Source documentation

The engine repository's ProjectGuide.md is the implementation guide for converted projects. The package code is the reference for method signatures and behaviour. This website provides a navigable reference for the native conversion workflow.

Zimension AI

Docs assistant

How can I help?

Ask anything about Zimension docs

AI may make mistakes. Always verify with official docs.