openscad

Files (11)

• LICENSE.source
• SKILL.md
• parametric_box.scad · examples/
• phone_stand.scad · examples/
• common.sh · tools/
• export-stl.sh · tools/
• extract-params.sh · tools/
• multi-preview.sh · tools/
• preview.sh · tools/
• render-with-params.sh · tools/
• validate.sh · tools/

SKILL.md (first lines)

# OpenSCAD Skill

Create, validate, and export OpenSCAD 3D models. Supports parameter customization, visual preview from multiple angles, and STL export for 3D printing platforms like MakerWorld.

## Prerequisites

OpenSCAD must be installed. Install via Homebrew:
```bash
brew install openscad
```

## Tools

This skill provides several tools in the `tools/` directory:

### Preview Generation
```bash
# Generate a single preview image
./tools/preview.sh model.scad output.png [--camera=x,y,z,tx,ty,tz,dist] [--size=800x600]

# Generate multi-angle preview (front, back, left, right, top, iso)
./tools/multi-preview.sh model.scad output_dir/
```

### STL Export
```bash
# Export to STL for 3D printing
./tools/export-stl.sh model.scad output.stl [-D 'param=value']
```

### Parameter Extraction
```bash
# Extract customizable parameters from an OpenSCAD file
./tools/extract-params.sh model.scad
```

### Validation
```bash
# Check for syntax errors and warnings
./tools/validate.sh model.scad
```

## Visual Validation (Required)

**Always validate your OpenSCAD models visually after creating or modifying them.**

After writing or editing any OpenSCAD file:

1. **Generate multi-angle previews** using `multi-preview.sh`
2. **View each generated image** using the `read` tool
3. **Check for issues** from multiple perspectives:
   - Front/back: Verify symmetry, features, and proportions
   - Left/right: Check depth and side profiles
   - Top: Ensure top features are correct
   - Isometric: Overall shape validation
4. **Iterate if needed**: If something looks wrong, fix the code and re-validate

This catches issues that syntax validation alone cannot detect:
- Inverted normals or inside-out geometry
- Misaligned features or incorrect boolean operations
- Proportions that don't match the intended design
- Missing or floating geometry
- Z-fighting or overlapping surfaces

**Never deliver an OpenSCAD model without visually confirming it looks correct from multiple angles.**

## Workflow

### 1. Creating an OpenSCAD Model

Write OpenSCAD code with customizable parameters at the top:

```openscad
// Customizable parameters
wall_thickness = 2;        // [1:0.5:5] Wall thickness in mm
width = 50;                // [20:100] Width in mm
height = 30;               // [10:80] Height in mm
rounded = true;            // Add rounded corners

// Model code below
module main_shape() {
    if (rounded) {
        minkowski() {
            cube([width - 4, width - 4, height - 2]);
            sphere(r = 2);
        }
    } else {
        cube([width, width, height]);
    }
}

difference() {
    main_shape();
    translate([wall_thickness, wall_thickness, wall_thickness])
        scale([1 - 2*wall_thickness/width, 1 - 2*wall_thickness/width, 1])
        main_shape();
}
```

Parameter comment format:
- `// [min:max]` - numeric range
- `// [min:step:max]` - numeric range with step
- `// [opt1, opt2, opt3]` - dropdown options
- `// Description text` - plain description

### 2. Validate the Model
```bash
./tools/validate.sh model.scad
```

### 3. Generate Previews

Generate preview images to visually validate the model:
```bash
./tools/multi-preview.sh model.scad ./previews/
```

This creates PNG images from multiple angles. Use the `read` tool to view them.

From OzcanOrhanDemirci/Mode_Code, Apache-2.0.

More from OzcanOrhanDemirci/Mode_Code