sketchup-bridge

SketchUp Bridge – Agent-Driven Iteration

When running or iterating on SketchUp Ruby code, always use the bridge. Do not ask the user to paste code into the SketchUp Ruby Console.

When you need to run code inside SketchUp and see results (e.g. test Timmerman::SkeletonDimensions.run, .clear, or any SketchUp Ruby):

1. Ensure the listener is running in SketchUp
   Option A (plugin — preferred): Install dist/timmerman_sketchup_bridge-1.0.0.rbz, set the bridge directory to this project's sketchup_bridge/ folder via Extensions → SketchUp Bridge → Set Bridge Directory…, then click Start Listener. The listener persists across sessions.
   Option B (manual): Paste once in the Ruby Console:
   load File.join('<path-to-this-repo>', 'sketchup_bridge', 'listener.rb')

2. Write the code to run
   Edit sketchup_bridge/command.rb. The default loads core.rb directly and calls run/clear:

   core = File.expand_path('../plugins/timmerman_skeleton_dimensions/core.rb', __dir__)
   load core
   Timmerman::SkeletonDimensions.debug_mode = true
   Timmerman::SkeletonDimensions.clear
   Timmerman::SkeletonDimensions.run
   "OK"
   

   The algorithm lives in plugins/timmerman_skeleton_dimensions/core.rb — edit that file, then re-run the bridge to test it.

3. Run and wait for result
   Execute: ruby sketchup_bridge/run_and_wait.rb
   The script touches command.rb so the listener runs it, then waits for results/result.txt written this run. It only succeeds when SketchUp actually runs the command (so you never get stale output). If the listener is not running, it times out and fails.

4. Use the output
   stdout/stderr from the command are in the printed result. Parse it to decide the next edit and repeat.

5. Programmatic screenshots (optional)
   Load the utils helper in command.rb and call take_screenshot:

   load File.expand_path('utils.rb', __dir__)
   SketchupBridgeUtils.take_screenshot                     # timestamped PNG in results/
   SketchupBridgeUtils.take_screenshot(name: "after_fix")  # results/after_fix.png
   

   The image is saved under sketchup_bridge/results/. See sketchup_bridge/utils.rb for options (width, height, antialias).

6. If the bridge is not connected
   When the listener is not running in SketchUp (or the IDE was not opened with the correct port), run_and_wait.rb will fail after a short timeout and print a clear "BRIDGE NOT CONNECTED" message. Report that to the user: tell them the bridge could not reach SketchUp and they need to start the listener in SketchUp (Extensions → SketchUp Bridge → Start Listener, or load the listener from the Ruby Console) and set the bridge directory, then rerun.

Do not ask the user to paste code into the Ruby Console for iteration; use the bridge (edit command.rb → run run_and_wait.rb → read output).