Skip to content

Debug Tools

The Debug panel is hidden by default. It becomes available when Debug Mode is enabled in preferences (see Add-on preferences).

Use the debug tools to capture a problem sync session, replay it offline without the Revit client, or import a payload file directly for inspection.

Screenshot needed: Debug panel — idle state, recording in progress, replay loaded

Recording

The Recording section captures a live sync session as a series of step files. Each sync payload received from Revit is saved as a separate step, so you end up with a recording you can play back one update at a time.

  • Start — begin recording; the panel shows the session name, step count, and save folder
  • Stop — end recording and finalize the session

Save location:

  • If the .blend file has been saved: recordings go into a bsync-recordings/ folder next to the .blend file
  • If the file is unsaved: recordings go into ~/bsync-recordings/ (user home directory)

When idle (no recording active), the panel displays the default recordings folder path for reference.

Replay

The Replay section lets you replay a captured session one step at a time to find exactly where something went wrong — no live Revit connection needed.

  • Load — opens a file browser to select a recording session
  • Reset — return to step 0
  • Next Step — advance one step; the panel shows the current step index and total step count

Tools

Import File — loads a sync payload directly from a JSON file on disk. Useful for testing or sharing specific sync states.

Clear Data — removes all BSync data from the current .blend file.

⚠️ Clear Data is irreversible. All documents, overrides, materials, and family data managed by BSync are permanently removed from the file. There is no undo. Save a backup before using this.