Using Chipmunk's Unity plugin with version control

Chipmunk keeps a local registry of imported Chipmunk assets with Unity metadata in a versioned file. If you’re using a version control solution to track changes to assets you can configure it to ignore individual changes made to assets that you’re storing in Chipmunk and instead keep track of one file, Chipmunk asset registry, which will keep a record of the current state of all imported assets.

Set up

Using .collabignore/.gitignore you can choose to ignore all Chipmunk assets in version control.

To do this, place all Chipmunk assets under a root folder and ignore that folder. Then, make sure to check the ChipmunkAssetRegistry folder under the Unity project root into version control.

Workflow steps

When you add a new revision to an existing asset in Chipmunk, as long as you have Import Automatically checked for that asset, the asset will automatically reflect the new revision in the Unity project.
You’ll need to check changes to the ChipmunkAssetRegistry folder into version control after updating an asset’s inspector properties (and check out changes made here when retrieving an asset’s inspector properties).
While the effects of a Pipeline applied to an asset should automatically sync, the Pipeline must remain in a folder that is not ignored. In the future, we plan on introducing an easier workflow for sharing Pipelines among team members and across different projects. 

Troubleshooting

If you ever experience an asset missing or not loading properly, try selecting Refresh All Chipmunk Assets (Assets > Chipmunk).

Still need help? Contact Us Contact Us