How gremlin529/vectric-box-gadget works
So the “system” you’re diagramming is not a distributed backend—it’s a plugin architecture:
• Host application: Vectric (the runtime environment)
• Packaging/release pipeline: PowerShell script that emits .vgadget
What the README adds (key architectural implications)
• The repo is intended to be cloned directly into the Vectric Gadgets directory and run “live” during development.
• Release is a deliberate process via MakeRelease.ps1 to generate versioned gadgets.
You want to capture runtime flow and build flow separately.
Vectric API → modifies Vectric Document Model
• Outputs: vectors, toolpaths, materials, etc.
Build/release flow
1. Source files (*_dev.lua, *_dev.html, stylesheets/, Images/) → input into MakeRelease.ps1
Architectural patterns / principles to explicitly highlight
• Plugin architecture / in-process extension: gadget runs within Vectric host.
• UI/Logic separation:
• Presentation layer: HTML/CSS/Images
• Logic layer: Lua
• Host API boundary:
• Lua is the only part that can directly manipulate the Vectric document via SDK/API.
• Artifact-based distribution:
• .vgadget is the deployable unit; repo is the source form.
Technologies to label
• Lua (core logic)
• HTML + CSS (UI)
• PowerShell (MakeRelease.ps1) for packaging
• Vectric Gadget Framework / SDK (host integration)
• .vgadget (packaging format)
Development & Release
• Repo working tree
• MakeRelease.ps1
• release/*.vgadget
Vectric Host Runtime
• Vectric Desktop App
• Gadget Host / SDK/API
• Vectric Document Model (Vectors/Toolpaths)
Gadget Internals
• HTML UI
• CSS
• Images
• Lua Script
Labels
• “Lua: Box_Creator_Ver_dev.lua”
• “UI: Box_Creator_Ver_dev.html”
• “CSS: stylesheets/*.css”
• “Assets: Images/*”
• “Release: Box_Creator_Ver_X.Y.vgadget”
• “User clicks / enters parameters”
• “Parameter values + commands”
• “Calls Vectric SDK/API”
• “Creates vectors/toolpaths in current job”
• “Loads CSS / images”
• “Packages / renames / emits .vgadget”
“Don’t overthink it” detail expansion (separate into many components)
• “Parameter validation”
• “Layer/material setup”
• “Toolpath generation”
Similarly, split UI into:
• “Input forms / controls”
• “Status/errors”
Build & Release Pipeline: repo → MakeRelease.ps1 → .vgadget → loaded by Vectric.
That pair will be the most accurate representation of this project as it exists in the tree and README.