scad-gltf 0.1.2 → 0.1.4

package/README.md

@@ -2,7 +2,7 @@
 
 A powerful WebAssembly (WASM) build of a custom OpenSCAD fork that enables direct compilation of OpenSCAD (`.scad`) scripts to **glTF/GLB** formats natively in JavaScript (Node.js and Browser).
 
-Unlike standard OpenSCAD, this custom engine supports **Physically Based Rendering (PBR)** materials, **Hierarchical Skeletal Animations**, and **Texture Baking**, making it a perfect bridge between procedural CAD generation and modern 3D web rendering engines (like Three.js or Babylon.js).
+Unlike standard OpenSCAD, this custom engine supports **Physically Based Rendering (PBR)** materials, **Hierarchical Node Animations**, and **Texture Baking**, making it a perfect bridge between procedural CAD generation and modern 3D web rendering engines (like Three.js or Babylon.js).
 
 The C++ source code for this custom OpenSCAD version is included directly in this repository within the `openscad/` subfolder.
 
@@ -14,8 +14,7 @@ The C++ source code for this custom OpenSCAD version is included directly in thi
 
 - **Direct SCAD to GLB conversion:** Compile geometry directly to web-ready binary glTF.
 - **Extended PBR Material Support:** Native extensions to the OpenSCAD `color()` module supporting `metalness`, `roughness`, `transmission` (glass), `thickness`, `ior`, `attenuationColor`, `attenuationDistance`, `clearcoat`, `sheen`, `emissive`, `specular`, and `iridescence`, plus a `$asa` special variable for auto smooth shading.
-- **Skeletal Animation:** Define animated armatures and bones directly within your `.scad` files.
-- **True Skeletal Skinning:** Exports absolute world transforms and properly bound animation tracks.
+- **Hierarchical Node Animation:** Define articulated, rigid-body hierarchies and keyframe animations using `armature()` and `bone()` modules. Exports proper glTF node transform tracks (rigid parenting rather than vertex-weighted skinning—ideal for robots, mechanical parts, vehicles, and articulated components).
 - **Texture Baking:** Automatically generate UVs and bake high-poly details (colors, normals, ORM) onto low-poly meshes using the new `bake()` module.
 - **Web Editor & Real-time Viewer (Scadify):** In-browser IDE with live WebAssembly compilation, GPU path tracing, animation timeline scrubbing, video/image export, URL sharing, and `.scad` / `.hdr` drag-and-drop.
 - **LLM Friendly:** Includes a built-in modular prompt generator (`prompt.js` and Web UI) to help AI models (like Gemini, Claude, or ChatGPT) write compatible OpenSCAD scripts utilizing the new features.
@@ -23,6 +22,7 @@ The C++ source code for this custom OpenSCAD version is included directly in thi
 - **CLI Converter:** Bundled `scad-convert` CLI utility for single file and batch compiling `.scad` files with smart dependency hashing.
 - **MCP Server for AI Agents:** Bundled `scad-mcp` server enables MCP clients to iteratively design, compile, and **visually inspect** 3D models via multi-angle headless rendering and animation frame evaluation.
 - **AI Studio Extension:** Chrome extension to natively preview, prompt, take chat snapshots, open in Scadify, and locally save AI-generated 3D models directly inside Google AI Studio.
+- **Godot 4 Integration & Web Demos:** Native Godot 4 importer addon for procedural `.scad` assets and prebuilt AI-generated [web game examples](https://iliagrigorevdev.github.io/scad-godot/).
 
 ---
 
@@ -32,7 +32,7 @@ The built-in web editor (**Scadify**) provides a full-featured development envir
 
 - **Real-Time 3D Viewport:** Instant WebAssembly compilation with auto-rendering, camera auto-framing, wireframe view, grid/axes toggles, ACES Filmic tone mapping, and full-screen mode.
 - **Photorealistic GPU Path Tracing:** Built-in hardware-accelerated path tracer with HDR environment lighting for realistic reflections, shadows, and glass refraction. Supports custom `.hdr` environment maps via drag-and-drop.
-- **Interactive Animation Controls:** Multi-animation selector, playback controls (play/pause), and smooth timeline scrubbing for skeletal rigs.
+- **Interactive Animation Controls:** Multi-animation selector, playback controls (play/pause), and smooth timeline scrubbing for animated hierarchies.
 - **Modular AI Prompt Generator:** Built-in UI with fine-grained feature toggles (Basic PBR, Auto Smooth, Animations, Extended PBR, Texture Baking) and persistent local settings to generate optimized prompts for LLMs.
 - **Image & Video Capture:**
   - **📷 PNG Snapshots:** Export high-resolution renders with a single click.
@@ -219,6 +219,7 @@ When asking an LLM (like Gemini) to generate OpenSCAD code, the extension automa
 - **Instant 3D Preview:** Injects a **"Preview 3D"** button on any OpenSCAD code block to compile and render the model in an embedded 3D viewer with grid, wireframe, and full-screen support.
 - **Visual Chat Feedback (📷):** Click the snapshot button inside the 3D preview window to capture a PNG snapshot of the model and **automatically paste it into the AI Studio chat input**, allowing Gemini to visually evaluate and fix geometry.
 - **Smart Prompt Injection:** Click the floating **"✨ SCAD"** button to open the configuration modal. Select your desired engine feature set (PBR, auto-smooth, animations, baking) to automatically generate and inject the prompt rules into your chat input.
+- **Local Model Refinement:** Connect to your local `scad-serve` workspace directly from the prompt modal. Select an existing `.scad` file to automatically append its source code to your prompt as a reference, enabling seamless AI iteration and refinement of your existing local designs.
 - **Open in Scadify:** Click **"Edit"** in the preview window to immediately transfer the current script into the full standalone Scadify editor via compressed URL hash.
 - **Local Workspace Saving:** Directly save and overwrite models to your local directory when running `scad-serve`.
 
@@ -284,7 +285,11 @@ This repository includes an official **Godot 4.x Importer Addon** located in the
 
 The addon allows you to drag-and-drop `.scad` files directly into your Godot project. It uses this WASM compiler under the hood to transform scripts into 3D scenes automatically.
 
-- **Features:** Supports PBR Materials and Skeletal Animations inside the Godot Editor.
+**🕹️ Play Web Demos (No Installation Required):**
+Try prebuilt AI-generated Godot games directly in your browser: [https://iliagrigorevdev.github.io/scad-godot/](https://iliagrigorevdev.github.io/scad-godot/)
+
+- **Features:** Supports PBR Materials and Hierarchical Node Animations inside the Godot Editor.
+- **Examples:** Check out AI-generated game templates in the [`godot/examples`](./godot/examples) directory.
 - **License:** The Godot Addon is licensed under **MIT**.
 - **Setup:** Simply copy the `addons/scad_importer` folder to your project and enable it in Project Settings.
 
@@ -329,9 +334,9 @@ color(
 }
 ```
 
-### 2. Skeletal Animations
+### 2. Hierarchical Node Animations (Rigid Parenting)
 
-Define hierarchical armatures, resting positions, and keyframe animations:
+Define hierarchical armatures, resting positions, and keyframe animations for rigid parts:
 
 ```openscad
 anim_data = [
@@ -422,7 +427,7 @@ console.log(promptContext);
 
 Once connected, an AI assistant can use the server to execute the following loop:
 
-1. **Retrieve Syntax Rules:** The assistant calls the `get_scad_prompt` tool to get the extended syntax rules for PBR materials, skeletal animations, and texture baking.
+1. **Retrieve Syntax Rules:** The assistant calls the `get_scad_prompt` tool to get the extended syntax rules for PBR materials, hierarchical node animations, and texture baking.
 2. **Generate Code:** The assistant writes the `.scad` script based on your design request.
 3. **Compile & Visually Inspect:** The assistant calls the `render_scad_model` tool to inspect rendered multi-angle frames and keyframes, fixing any errors before final export.
 

package/bin/scad-godot.js

@@ -90,7 +90,7 @@ async function main() {
     console.error("");
     console.error("Example with JSON options:");
     console.error(
-      '  scad-godot "Game description" \'{"animation": false, "bakeColors": true}\'',
+      '  scad-godot "Game description" \'{"animation": false, "bakeColors": true, "scadFiles": ["player.scad"]}\'',
     );
     process.exit(1);
   }
@@ -102,6 +102,7 @@ async function main() {
     clearcoat: false,
     sheen: false,
     iridescence: false,
+    scadFiles: [],
   };
 
   if (optionsStr) {
@@ -138,6 +139,9 @@ async function main() {
     process.exit(1);
   }
 
+  const hasUserScadFiles =
+    Array.isArray(options.scadFiles) && options.scadFiles.length > 0;
+
   // 4. Construct the Main Godot Prompt System Text (System Instructions)
   const systemPrompt = `You are an expert Godot 4 game developer and procedural 3D technical artist.
 
@@ -158,7 +162,7 @@ What to generate:
      * OpenSCAD -Y (Back)    -> Godot +Z (Back)
      * OpenSCAD +Z (Up)      -> Godot +Y (Up)
      DO NOT manually apply root rotations (e.g., \`rotate([90, 0, 0])\`) to compensate for Godot.
-   - CRITICAL: You must use the custom OpenSCAD glTF extensions for PBR materials (e.g., \`roughness\`, \`metalness\`, \`emissive\`) and Skeletal Animations (\`armature()\`, \`bone()\`). The rules and syntax for these features are provided below:
+   - CRITICAL: You must use the custom OpenSCAD glTF extensions for PBR materials (e.g., \`roughness\`, \`metalness\`, \`emissive\`) and Hierarchical Node Animations (\`armature()\`, \`bone()\`). The rules and syntax for these features are provided below:
 
 === OPENSCAD SYNTAX RULES ===
 ${promptRules}
@@ -185,7 +189,11 @@ ${promptRules}
    - The script must embed and write:
      - Your generated \`.scad\` game assets.
      - Your generated Godot project files.
-     - The exact source code of the provided \`addons/scad_importer/*\` files, placed in their correct respective paths.
+     - The exact source code of the provided \`addons/scad_importer/*\` files, placed in their correct respective paths.${
+       hasUserScadFiles
+         ? "\n     - The exact source code of the provided user `.scad` files, placed in the appropriate project folders."
+         : ""
+     }
    - Ensure all string file contents inside the Node.js script are properly escaped.`;
 
   // 5. Gather Addon Files content
@@ -229,6 +237,24 @@ ${promptRules}
     }
   }
 
+  if (hasUserScadFiles) {
+    systemClipboardOutput += `=== USER PROVIDED OPENSCAD FILES ===\n`;
+    systemClipboardOutput += `The following .scad files are provided as reference or base assets. You MUST embed and write them into the generated project, modifying them if necessary to fit the game logic.\n\n`;
+    for (const file of options.scadFiles) {
+      try {
+        const content = fs.readFileSync(file, "utf-8").replace(/\r\n/g, "\n");
+        const relativePath = path.isAbsolute(file)
+          ? path.relative(process.cwd(), file).replace(/\\/g, "/")
+          : file.replace(/\\/g, "/");
+        systemClipboardOutput += `### ${relativePath}\n---\n\`\`\`openscad\n${content}\n\`\`\`\n\n`;
+      } catch (e) {
+        console.error(
+          `Warning: Skipping user SCAD file '${file}'. It is not a readable file.`,
+        );
+      }
+    }
+  }
+
   systemClipboardOutput = systemClipboardOutput.trimEnd() + "\n";
 
   // 7. Format the input request output

package/bin/scad-web.js

@@ -137,7 +137,7 @@ What to generate:
 1. 3D Web Assets (.scad):
    - Generate procedural 3D models for the web app using OpenSCAD.
    - CRITICAL: The SCAD to glTF converter automatically converts OpenSCAD's Z-up coordinate system to the standard glTF Y-up coordinate system. Design your models naturally in OpenSCAD.
-   - CRITICAL: You must use the custom OpenSCAD glTF extensions for PBR materials (e.g., \`roughness\`, \`metalness\`, \`emissive\`) and Skeletal Animations (\`armature()\`, \`bone()\`). The rules and syntax for these features are provided below:
+   - CRITICAL: You must use the custom OpenSCAD glTF extensions for PBR materials (e.g., \`roughness\`, \`metalness\`, \`emissive\`) and Hierarchical Node Animations (\`armature()\`, \`bone()\`). The rules and syntax for these features are provided below:
 
 === OPENSCAD SYNTAX RULES ===
 ${promptRules}