Version Control

Checkpoints

Nucleus supports historical versions of files. These versions are called “Checkpoints”. A Checkpoint represents the contents of a file at a certain point in time and cannot be modified once it has been created. It is immutable.

The concept of “Branches” is also being supported although at this writing only one branch is supported - called the “default” branch. This feature is expected to grow into supporting many branches.

Term

Meaning

Can be edited

Branch

An alternate version of a file.

Yes

Head Revision

The most recent version of a file on a branch.

Yes

Checkpoint

A historical version of a file.

No

URL Schema

With Version Control, Nucleus URLs are using query parameters indicate branch and checkpoint. URLs without query parameters continues to work because they are assumed to reference the head revision of files on the “default” branch.

The most explicit URL for a checkpoint file states the query parameters by name and value; for example, omniverse://127.0.0.1/Assets/car.usd?branch=default&checkpoint=5

Abbreviated versions of checkpoint URLs are also supported:

  • omniverse://127.0.0.1/Assets/car.usd?default&5

  • omniverse://127.0.0.1/Assets/car.usd?&5 (“default” branch is assumed)

The most explicit URL for a branch file: omniverse://127.0.0.1/Assets/car.usd?branch=default

Abbreviated versions of branch URLs:

  • omniverse://127.0.0.1/Assets/car.usd?default

  • omniverse://127.0.0.1/Assets/car.usd (“default” branch is assumed)

How are Checkpoints Created

Checkpoints are created by various Omniverse clients when files are created, saved, exported etc.

To find out more about version control in clients:

Turn Feature ON/OFF

Nucleus supports turning version control ON/OFF as a feature.

Please note that turning the version control feature OFF on a server that is already managing files is risky. For example, the server cannot convert existing checkpoints into “regular files” when the feature is turned off.

It is recommended that the feature is turned OFF before you create any files on the server.

  1. Open [launcher installation directory]/library/nucleus-workstation-2021.1.0-rc.4/Nucleus/omni.verifier.app.config.json in a text editor.

  2. Set “versioning”: “%OMNI_VERSIONING%?:true” or “versioning”: “%OMNI_VERSIONING%?:false”.

  3. Save the file.

  4. Stop and Start the Nucleus server from the System Monitor to apply the settings.