GleipnirRig 1.0.2 — illustrated manual
Learn the handoff workflow with the included fictional rigs. The screenshots show GleipnirRig 1.0.2 in Blender 4.5.14 LTS on Linux and its actual exported report in a browser.
1. Install
Extract the outer gleipnir_rig-1.0.2-bundle.zip first. Keep the inner extension ZIP intact. To update, disable and remove the earlier extension in Preferences, restart Blender, and install the new inner ZIP. Existing rig files are not changed by installation.
- Blender 4.5: Edit ▸ Preferences ▸ Get Extensions.
- ⌄ (top right) ▸ Install from Disk… and pick
gleipnir_rig-1.0.2.zip. - Check that GleipnirRig Handoff Check is enabled in Preferences ▸ Add-ons.
Preferences (Add-ons ▸ GleipnirRig):
- Blender for simulation: empty means the Blender you are running.
- Time limit: default 180 s.
- Keep temporary files: for troubleshooting.
- Hide home folder in exports: default on.
2. Open the panel and check the prerequisites
Open the rig file, press N in the 3D Viewport and click the GleipnirRig tab. Pick the collection you deliver. Each prerequisite shows a check mark, a red cross (blocks the recipient simulation) or an info icon. The panel never saves your file.
3. Run the check: progress and cancel
Run Handoff Check first runs the read-only source audit. It then starts a separate Blender for the recipient simulation. The progress bar shows the step, and Cancel (or Esc) stops the child process. A cancelled run keeps every recipient check as Not run. It is never reported as a pass.
4. Read the results
The results panel shows the verdict, counts per status and collapsible groups. Every problem has a Next: action.
Simple rig (gr_simple_rig.blend): no confirmed failures. The rig was linked, overridden, posed, keyed, saved and reopened in the recipient simulation. The panel still does not call the rig "good".
Property/override problem (gr_override_problem.blend): the recipient could not keep edits to two custom properties that are not Library Overridable, and a mesh is deformed by an armature outside the collection.
Script sentinel (gr_script_sentinel.blend): a registered rig-UI text block and a Python-expression driver. GleipnirRig lists them as manual checks and never runs them. The window behind the panel shows Blender's own warning that script auto-execution was blocked when the file was opened.
Missing dependency (gr_missing_dependency.blend): a texture and a linked library that were never shipped. They are confirmed as missing both in the source and in the recipient simulation.
5. Unsaved changes are refused, never saved for you
After any edit, the recipient simulation is refused with the reason. The source audit still runs. Save (Ctrl S) and run again.
6. Export the report and the recipient guide
Export Report & Recipient Guide… writes three files next to each other. A result from before a rig edit, collection change, different file or changed saved-file hash is refused. Save and run the check again. An explicitly incomplete diagnostic from an unsaved-file check can still be exported; it never becomes a successful handoff.
Read the decision at the top of the report. Not ready to hand off in the HTML report, and HANDOFF PAUSED in recipient instructions, mean fix and recheck before sending the rig. The report lists the next actions first and keeps passed checks in a keyboard-operable disclosure. On phones, wide evidence tables scroll within the page.
The three exports are:
| File | Contents |
|---|---|
NAME.html | Offline report: no scripts, no external resources (Content-Security-Policy default-src 'none'), all values HTML-escaped |
NAME-evidence.json | Complete machine-readable evidence (schema gleipnir-rig/handoff-report@1) |
NAME-recipient-instructions.txt | Plain-text guide for the animator: how to link and override, which properties they can animate, which scripts need review, open issues |
The exported HTML report, rendered by Chromium with networking disabled:
7. Status reference
| Status | Meaning |
|---|---|
| Confirmed failure | Reproduced problem the recipient will hit. |
| Warning | Likely problem or risky setup. |
| Manual check | Cannot be decided safely by the tool, for example scripts. |
| Not run | Did not run in this session. The reason is shown. Never a pass. |
| Checked OK | Ran and found nothing wrong. Not a certificate. |
8. Limits
- Only Blender 4.5 LTS and ordinary armature + mesh collections are supported. Tested on Linux x64.
- Rig UI scripts and Python drivers are never executed, so their behaviour is not verified.
- Animation correctness, deformation quality and every driver/constraint combination are out of scope.
- The recipient simulation runs on your computer. The recipient's OS, paths and add-ons may differ.
- In background (scripted) mode Blender cannot report unsaved changes. Scripted runs need
assume_saved=Trueand are marked with a warning.
9. Try the supplied example before your own rig
Extract gleipnir_rig-1.0.2-examples.zip. Open gleipnir_rig_examples/gr_override_problem.blend with script auto-execution disabled. Choose its rig collection and run Run Handoff Check. The supplied failing example reports three confirmed failures: an armature dependency outside the collection and custom properties that the recipient cannot preserve as edits. Read the specific next actions, rather than treating a loaded file as proof of a working rig. The separate simple example has no confirmed failures in the checks that ran. It does not certify animation or deformation quality.
Open the saved sample reports in examples/reports/ alongside this guide. They use generated fictional rigs and record the checked version and environment. They are examples, not a check of your file. Read paths and asset names before sharing any report with a recipient.
10. Remove the extension
In Blender Preferences, find GleipnirRig Handoff Check in Add-ons, disable it, then use Remove. Saved rig files and already exported reports remain yours. Stop a running check with Cancel before removing the extension.