scad-gltf 0.3.3 → 0.5.0

package/src/project-prompts.js

@@ -6,18 +6,57 @@ const __filename = url.fileURLToPath(import.meta.url);
 const __dirname = path.dirname(__filename);
 const DIR = path.resolve(__dirname, "..");
 
+function readFile(filePath) {
+  try {
+    return fs.readFileSync(filePath, "utf-8").replace(/\r\n/g, "\n");
+  } catch (e) {
+    console.error(`Warning: Skipping file '${filePath}'. It is not readable.`);
+    return null;
+  }
+}
+
+function formatMarkdownFile(displayPath, lang, content) {
+  return `### ${displayPath}\n---\n\`\`\`${lang}\n${content}\n\`\`\`\n\n`;
+}
+
+function appendUserScadFiles(options = {}, isRawScad = false) {
+  if (
+    !options.scadFiles ||
+    !Array.isArray(options.scadFiles) ||
+    options.scadFiles.length === 0
+  ) {
+    return "";
+  }
+
+  let output = `\n\n=== USER PROVIDED OPENSCAD FILES ===\n`;
+  if (isRawScad) {
+    output += `The following .scad files are provided as reference or base assets. You MUST embed their contents directly into your final single OpenSCAD file (or use them as context), modifying them if necessary to fit the project logic.\n\n`;
+  } else {
+    output += `The following .scad files are provided as reference or base assets. You MUST embed and write them into the generated project (or use them as context), modifying them if necessary to fit the project logic.\n\n`;
+  }
+  for (const file of options.scadFiles) {
+    const content = readFile(file);
+    if (content !== null) {
+      const relativePath = path.isAbsolute(file)
+        ? path.relative(process.cwd(), file).replace(/\\/g, "/")
+        : file.replace(/\\/g, "/");
+      output += formatMarkdownFile(relativePath, "openscad", content);
+    }
+  }
+  return output;
+}
+
 export function getProjectPrompts(projectType) {
   if (projectType === "scad") {
     return {
-      buildSystemPrompt: () =>
-        `You are an expert procedural 3D technical artist and OpenSCAD developer.
-Your goal is to generate a single OpenSCAD (.scad) file based on the user's request.
-
-CRITICAL WORKFLOW:
-1. Write the OpenSCAD code using the custom syntax rules provided in the request.
-2. Call the \`render_scad_model\` tool with your code to visually verify your design.
-3. If the model looks incorrect, adjust your code and re-render. Iterate until perfect.
-4. Provide your final OpenSCAD code in a standard markdown block (\`\`\`openscad).`,
+      buildSystemPrompt: (promptRules, options = {}) => {
+        let output = promptRules;
+        if (Array.isArray(options.scadFiles) && options.scadFiles.length > 0) {
+          output += appendUserScadFiles(options, true);
+        }
+        return output;
+      },
+      buildInputRequest: (task) => task,
       allowedTools: ["render_scad_model"],
     };
   }
@@ -28,9 +67,11 @@ CRITICAL WORKFLOW:
     const depName = isBevy ? "bevy" : "wgpu";
 
     return {
-      buildSystemPrompt: (
-        promptRules,
-      ) => `You are an expert Rust ${frameworkName} developer and procedural 3D technical artist.
+      buildSystemPrompt: (promptRules, options = {}) => {
+        const hasUserScadFiles =
+          Array.isArray(options.scadFiles) && options.scadFiles.length > 0;
+
+        const systemPrompt = `You are an expert Rust ${frameworkName} developer and procedural 3D technical artist.
 
 NAMING CONVENTION REQUIREMENT:
 - All generated files, directories, models, scripts, and root folders MUST strictly use snake_case (lowercase with underscores, e.g. \`player_character.rs\`, \`enemy_walker.scad\`).
@@ -49,31 +90,7 @@ ${promptRules}
 2. Rust ${frameworkName} Project Files:
    - Create the necessary files for a modern Rust ${frameworkName} application (e.g., \`Cargo.toml\`, \`build.rs\`, \`src/main.rs\`).
    - In \`Cargo.toml\`, include \`${depName}\` as a dependency.
-   - You MUST include this EXACT \`build.rs\` script at the root of the project to automatically compile the \`.scad\` files into \`.glb\` format inside the \`assets/models\` folder before running the application via Cargo:
-     \`\`\`rust
-     use std::process::Command;
-
-     fn main() {
-         // Tell Cargo to re-run this script only if the 'scad' directory changes
-         println!("cargo::rerun-if-changed=scad");
-
-         // Ensure cross-platform compatibility for npm global binaries
-         let cmd = if cfg!(target_os = "windows") {
-             "scad-gltf.cmd"
-         } else {
-             "scad-gltf"
-         };
-
-         let status = Command::new(cmd)
-             .args(["convert", "./scad", "./assets/models", "--cache"])
-             .status()
-             .expect("Failed to execute scad-gltf. Is scad-gltf installed globally?");
-
-         if !status.success() {
-             panic!("scad-gltf convert failed with status: {}", status);
-         }
-     }
-     \`\`\`
+   - You MUST include the provided \`build.rs\` script at the root of the project to automatically compile the \`.scad\` files into \`.glb\` format inside the \`assets/models\` folder before running the application via Cargo.
    - Write the core application logic in \`src/main.rs\` to load and display the converted \`.glb\` files interactively.${
      isBevy
        ? " Provide standard Bevy systems (camera, lights, movement, etc.)."
@@ -83,11 +100,34 @@ ${promptRules}
 3. Delivery Format (Single Node.js Script):
    - Output exactly ONE self-contained Node.js script. Do not output manual setup instructions.
    - CRITICAL: The generated Node.js script MUST first create a root project folder (named using a slugified version of the project name) and output all files and folders inside this newly created project folder.
+   - CRITICAL: You MUST use \`process.cwd()\` (and NOT \`__dirname\`) when defining the target directory path (e.g. \`const rootDir = path.join(process.cwd(), "my_project");\`). This ensures the script extracts correctly into whatever temporary folder it is executed from.
    - When executed, this script must programmatically create the entire project directory structure and write all the files to disk using the \`fs\` module.
    - The script must embed and write:
      - Your generated \`.scad\` 3D assets.
-     - Your generated Rust ${frameworkName} project files (\`Cargo.toml\`, \`build.rs\`, \`src/main.rs\`).
-   - Ensure all string file contents inside the Node.js script are properly escaped.`,
+     - Your generated Rust ${frameworkName} project files (\`Cargo.toml\`, \`src/main.rs\`).
+     - The exact source code of the provided \`build.rs\` file, placed in the project root.${
+       hasUserScadFiles
+         ? "\n     - The provided user `.scad` files (modified if necessary), placed in the appropriate project folders."
+         : ""
+     }
+   - Ensure all string file contents inside the Node.js script are properly escaped.`;
+
+        let systemClipboardOutput = `${systemPrompt}\n\n`;
+
+        const buildRsPath = path.join(DIR, "rust", "build.rs");
+        const buildRsContent = readFile(buildRsPath);
+        if (buildRsContent !== null) {
+          systemClipboardOutput += formatMarkdownFile(
+            "build.rs",
+            "rust",
+            buildRsContent,
+          );
+        }
+
+        systemClipboardOutput += appendUserScadFiles(options);
+
+        return systemClipboardOutput.trimEnd() + "\n";
+      },
       buildInputRequest: (task) =>
         `Design and implement a Rust ${frameworkName} project for the following concept: "${task}"`,
       allowedTools: ["render_scad_model", "compile_rust_project"],
@@ -96,9 +136,12 @@ ${promptRules}
 
   if (projectType === "web") {
     return {
-      buildSystemPrompt: (
-        promptRules,
-      ) => `You are an expert Web 3D developer and procedural 3D technical artist.
+      buildSystemPrompt: (promptRules, options = {}) => {
+        const hasUserScadFiles =
+          Array.isArray(options.scadFiles) && options.scadFiles.length > 0;
+
+        return (
+          `You are an expert Web 3D developer and procedural 3D technical artist.
 
 What to generate:
 1. 3D Web Assets (.scad):
@@ -124,11 +167,19 @@ ${promptRules}
 3. Delivery Format (Single Node.js Script):
    - Output exactly ONE self-contained Node.js script. Do not output manual setup instructions.
    - CRITICAL: The generated Node.js script MUST first create a root project folder (named using a slugified version of the project name) and output all files and folders inside this newly created project folder.
+   - CRITICAL: You MUST use \`process.cwd()\` (and NOT \`__dirname\`) when defining the target directory path (e.g. \`const rootDir = path.join(process.cwd(), "my_project");\`). This ensures the script extracts correctly into whatever temporary folder it is executed from.
    - When executed, this script must programmatically create the entire project directory structure and write all the files to disk using the \`fs\` module.
    - The script must embed and write:
      - Your generated \`.scad\` 3D assets.
-     - Your generated Vite web project files.
-   - Ensure all string file contents inside the Node.js script are properly escaped.`,
+     - Your generated Vite web project files.${
+       hasUserScadFiles
+         ? "\n     - The provided user `.scad` files (modified if necessary), placed in the appropriate project folders."
+         : ""
+     }
+   - Ensure all string file contents inside the Node.js script are properly escaped.` +
+          appendUserScadFiles(options)
+        );
+      },
       buildInputRequest: (task) =>
         `Design and implement a web-based 3D glTF project using Vite for the following concept: "${task}"`,
       allowedTools: ["render_scad_model"],
@@ -177,27 +228,26 @@ ${promptRules}
      * Left/Right Convention in Godot Script: Maintain anatomical consistency in scripts—character Right is along +X (\`transform.basis.x\`) and character Left is along -X (\`-transform.basis.x\`).
      * Natural Model Alignment: Because OpenSCAD models face +Y (Forward), they automatically import facing Godot's Forward direction (-Z). Built-in Godot methods like \`look_at()\` orient the node's -Z axis toward the target, which perfectly aligns with the model's front. Do NOT apply compensation rotations (e.g., \`rotate_y(PI)\`) in GDScript to compensate for model orientation.
    - Generate a \`project.godot\` file. It must configure the project and automatically enable the \`scad_importer\` plugin.
-   - Generate a \`.gitignore\` file that ignores the \`.godot/\` folder.
-   - Generate a \`README.md\` file that documents the project, mechanics/features, and controls.
 
 3. Delivery Format (Single Node.js Script):
    - Output exactly ONE self-contained Node.js script. Do not output manual setup instructions.
    - CRITICAL: The generated Node.js script MUST first create a root project folder (named using snake_case with underscores, e.g., \`my_project\`) and output all files and folders inside this newly created project folder.
+   - CRITICAL: You MUST use \`process.cwd()\` (and NOT \`__dirname\`) when defining the target directory path (e.g. \`const rootDir = path.join(process.cwd(), "my_project");\`). This ensures the script extracts correctly into whatever temporary folder it is executed from.
    - When executed, this script must programmatically create the entire project directory structure and write all the files to disk using the \`fs\` module.
    - The script must embed and write:
      - Your generated \`.scad\` assets.
      - Your generated Godot project files.
      - 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."
+         ? "\n     - The provided user `.scad` files (modified if necessary), placed in the appropriate project folders."
          : ""
      }
-   - Ensure all string file contents inside the Node.js script are properly escaped.
-   - TESTING CAPABILITY: You have access to the \`test_godot_project\` tool. If you want to verify your code before outputting your final response, you can pass your complete generated Node.js script as the \`nodejs_script\` parameter. The server will execute it in a temporary folder and run the Godot tests automatically.`;
+   - Ensure all string file contents inside the Node.js script are properly escaped.`;
+
+        let systemClipboardOutput = `${systemPrompt}\n\n`;
 
         // Gather Addon Files content
         const addonDir = path.join(DIR, "godot", "addons", "scad_importer");
-        let addonFiles = [];
         try {
           if (fs.existsSync(addonDir)) {
             const files = fs.readdirSync(addonDir);
@@ -207,7 +257,16 @@ ${promptRules}
                 fs.statSync(fullPath).isFile() &&
                 (file.endsWith(".gd") || file.endsWith(".cfg"))
               ) {
-                addonFiles.push(fullPath);
+                const content = readFile(fullPath);
+                if (content !== null) {
+                  const relativePath = `addons/scad_importer/${file}`;
+                  const lang = file.endsWith(".gd") ? "gdscript" : "text";
+                  systemClipboardOutput += formatMarkdownFile(
+                    relativePath,
+                    lang,
+                    content,
+                  );
+                }
               }
             }
           }
@@ -215,42 +274,7 @@ ${promptRules}
           console.error("Warning: Could not read addon directory.", e);
         }
 
-        let systemClipboardOutput = `${systemPrompt}\n\n`;
-
-        for (const file of addonFiles) {
-          try {
-            const content = fs
-              .readFileSync(file, "utf-8")
-              .replace(/\r\n/g, "\n");
-            const relativePath = path.relative(DIR, file).replace(/\\/g, "/");
-            const lang = file.endsWith(".gd") ? "gdscript" : "text";
-            systemClipboardOutput += `### ${relativePath}\n---\n\`\`\`${lang}\n${content}\n\`\`\`\n\n`;
-          } catch (e) {
-            console.error(
-              `Warning: Skipping '${file}'. It is not a readable file.`,
-            );
-          }
-        }
-
-        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 project 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 += appendUserScadFiles(options);
 
         return systemClipboardOutput.trimEnd() + "\n";
       },

package/src/prompt.js

@@ -27,6 +27,7 @@ export function generatePrompt(description, options = {}) {
     animation: options.animation ?? true,
     lazyUnion: options.lazyUnion ?? false,
     modelName: options.modelName ?? true,
+    lights: options.lights ?? false,
   };
 
   let prompt = `Generate an OpenSCAD script to design the following: ${description}.`;
@@ -117,6 +118,7 @@ export function generatePrompt(description, options = {}) {
     prompt += `\n\nImportant Animation rules:
 - Wrapping: Use the 'armature(animations=...)' module at the root to wrap all animated components.
 - Hierarchies: Use the 'bone(name="BoneName", t=[x,y,z], r=[x,y,z])' module to define hierarchical animated parts.
+- Camera Animation: You can create an animated glTF camera by naming a bone "Camera" or "camera". You can append numbers or separators to the name (e.g., "Camera1", "Camera_fov60" for Perspective 60 deg FOV, or "Camera_ortho_mag10" for Orthographic, scale 10). Physical parts like "CameraMount" are safely ignored. It will animate just like any other bone! Note: The camera looks forward along the +Y axis, with +Z as its UP direction.
 - Auto-Unioning: Any child meshes (e.g., cube, cylinder, imported objects) placed directly inside an 'armature()' or 'bone()' node are automatically unioned together by the engine and rigidly attached to that bone's transform node. Child bones remain separate nodes in the hierarchy.
 - Animation Data: The 'animations' property is an array of named animation sequences. Each sequence contains an array of tracks defining keyframes for each bone. Format:
   animations = [
@@ -229,5 +231,24 @@ bake(uvs=true) {
 \`\`\``;
   }
 
+  if (opts.lights) {
+    prompt += `\n\nImportant Lighting rules:
+- Lights: Use the 'light()' module to add lights to the scene.
+- Syntax: \`light(type="point", color=[1,1,1], intensity=2000.0, range=0.0, innerConeAngle=0.0, outerConeAngle=45.0) { ... }\`
+- Supported light types: "directional", "point", "spot".
+- Intensity (Physically Correct): Directional lights use Lux (e.g., 300-500 for indoor lighting, 100000 for the sun). Point and Spot lights use Candelas and decay over distance via the inverse-square law. They require VERY HIGH values (e.g., 1000.0 to 10000.0+) to illuminate objects!
+- Orientation: A directional or spot light shines in the -Z direction by default. Use \`translate()\` and \`rotate()\` around the \`light()\` module to position and orient it.
+- Spot lights accept \`innerConeAngle\` and \`outerConeAngle\` (in degrees). Point/Spot lights accept \`range\` (0.0 means infinite).
+- Children inside a \`light()\` block are rendered normally in OpenSCAD and exported. The light transform automatically follows its enclosing transformations.
+
+Example Lighting Usage:
+\`\`\`openscad
+// A spot light pointing down at an angle (Note the high intensity of 5000)
+translate([0, 0, 50]) rotate([0, 30, 0])
+  light(type="spot", color=[1, 0.8, 0.8], intensity=5000.0, innerConeAngle=15.0, outerConeAngle=30.0)
+    color("gray") cylinder(h=2, r=1, center=true); // A visual representation of the light fixture
+\`\`\``;
+  }
+
   return prompt;
 }