Kzm file format

Kzm is the Kanzi Studio project file format that replaces the kzproj file format. Instead of a single kzproj project file, Kanzi Studio stores your project in multiple kzm files. Each kzm file contains data for one project item. For example, each material type, material, animation, render pass, and so on has its own kzm file.

The goal of the kzm file format is to improve change review, teamwork, and collaboration on Kanzi Studio projects by:

• Providing granular, human-readable files so you can clearly see and review exactly what changed

• Reducing merge conflicts and making any remaining ones easier to resolve

• Simplifying the sharing of project items between different projects

• Enabling scriptable modifications through diff-friendly files

Note

Your feedback is very important to us.

Submit your feedback on the kzm file format here.

Kanzi Studio can still open kzproj projects, but when you save such a project, Kanzi Studio automatically converts it to kzm and removes the kzproj file. This conversion is not reversible. Once you save a project in kzm format, you can no longer revert that project to the kzproj format.

Kanzi Studio shows a notification to inform you about the conversion before completing the save operation.

Reusing project items

Kzm files simplify reuse of Kanzi Studio project items. To use a project item in another project, copy the kzm file of that project item into the correct directory of another project. When a project item has child items or refers to other items, copy all child and referred items too.

For example:

• To copy a Render Pass Prefab:

  1. In File Explorer, in the project directory open the Render Pass Prefabs directory of the first project.

  2. Copy Example Render Pass directory and Example Render Pass.kzm render pass prefab file.

  3. Paste the directory and kzm file to the Render Pass Prefabs directory of the second project.

     

• To copy a Material:

  1. In File Explorer, copy FirstProject/Materials/ExampleMaterial.kzm to the SecondProject/Materials/ directory.

     

  2. Copy the material type FirstProject/Material Types/ExampleMaterialType.kzm to the SecondProject/Material Types/ directory.

     

  3. Copy the shaders and the corresponding kzm files from the FirstProject/Shaders/ directory to the SecondProject/Shaders/ directory.