# Introduction

OpenSCAD is software for creating solid 3D CAD objects. It is free software and available for GNU/Linux, Microsoft Windows and Mac OS X.
Unlike most free software for creating 3D models (such as the well-known application Blender), OpenSCAD does not focus on the artistic aspects of 3D modelling, but instead focuses on the CAD aspects. So it might be the application you are looking for when you are planning to create 3D models of machine parts, but probably is not what you are looking for when you are more interested in creating computer-animated movies or organic life-like models.
OpenSCAD, unlike many CAD products, is not an interactive modeler. Instead it is something like a 2D/3D-compiler that reads in a program file that describes the object and renders the model from this file. This gives you (the designer) full control over the modelling process. This enables you to easily change any step in the modelling process and make designs that are defined by configurable parameters.
OpenSCAD has two main operating modes, Preview and Render. Preview is relatively fast using 3D graphics and the computer's GPU, but is an approximation of the model and can produce artifacts; Preview uses OpenCSG and OpenGL. Render generates exact geometry and a fully tessellated mesh. It is not an approximation and as such it is often a lengthy process, taking minutes or hours for larger designs. Render uses CGAL as its geometry engine.
OpenSCAD provides two types of 3D modelling:
* Constructive Solid Geometry (CSG)
* extrusion of 2D primitives into 3D space.
SVG is used for 2D while Autocad DXF files can be used as well for the data exchange format for 2D outlines. In addition to 2D paths for extrusion it is also possible to read design parameters from DXF files. Besides DXF files, OpenSCAD can read and create 3D models in the open 3mf, STL, OFF and many more file formats.
OpenSCAD can be downloaded from https://www.openscad.org/. More information is available on the mailing list.

## Additional Resources

A clear guided introduction to using OpenSCAD and to the OpenSCAD language is available in the OpenSCAD Tutorial.
For Teachers: a basic 25-slide presentation from 2014 is available under GNUFDL to walk your students through the process of using OpenSCAD here.
Fablab Lannion (France) edited a nice French-language interactive tutorial that you might appreciate.
A "cheat sheet" is a useful quick reference for the OpenSCAD language, with each item linking back to this Wikibook.
A list of books can be found here.

## History

Periodically the two manuals below get cleaned up or have major transitions. Consider archiving the manuals prior to starting a major update.
This can be done for the two 'printable version' links below to the Internet Archive
* 2018-04-25 The OpenSCAD User Manual - Print Version & The OpenSCAD Language - Print Version
* 2019-07-22 The OpenSCAD User Manual Which includes links to the archives of the above two printed versions (as of this date).
The Wayback Machine no longer has a free user requested site archive, so below is just the two 'printable version' manuals
* 2020-12-11 The OpenSCAD User Manual - Print Version & The OpenSCAD Language - Print Version

# The OpenSCAD User Manual

* Introduction
* First Steps
* The OpenSCAD User Interface
* Input Devices
* Customizer
* Import - STL, 3MF, OFF, AMF, DXF, SVG, CSG
** SVG Import
* Export - STL, 3MF, OFF, AMF, DXF, SVG, CSG, PNG
** STL Export
** CSG Export
** DXF Extrusion
** Other 2D formats
* Example Projects
** Strandbeest
* Paths
* Using an external Editor with OpenSCAD
* Integration with other applications
* Using OpenSCAD in a command line environment
* Building OpenSCAD from Sources
** Building on Linux/UNIX
** Cross-compiling for Windows on Linux or Mac OS X
** Building on Windows (Outdated)
** Building on Windows (New)
** Building on Mac OS X
** Submitting patches
* Frequently Asked Questions
* Libraries
* Tips and Tricks
* Command Glossary - Very short name and syntax reference

# The OpenSCAD Language Reference

* The OpenSCAD Language
** General - READ THIS FIRST - comments, values and data types, variables, vectors, getting input
* 3D objects -
** 3D Primitive Solids - cube, sphere, cylinder, polyhedron
** 3D to 2D Projection
* 2D Objects
** 2D Primitives - square, circle, polygon
** Text - Generate text using installed or user supplied font files.
** 2D to 3D - linear_extrude, rotate_extrude
* Transform
** color
** rotate, translate, mirror, multmatrix
** scale, resize
** offset, minkowski, hull
** Combining transformations
* Boolean combination
** union, difference, intersection, render
* Other Functions and Operators
** Conditional and Iterator Functions - for, intersection_for, if, conditional ? :, assign, let
** Mathematical Operators - General, Vectors, Matrix multiplication
** Mathematical Functions
*** Trigonometric (cos sin tan acos asin atan atan2)
*** Other (abs ceil concat cross exp floor ln len let log lookup max min norm pow rands round sign sqrt)
** String Functions - str, chr, ord
** Type Test Functions - is_undef, is_bool, is_num, is_string, is_list
** List Comprehensions
** Other Language Features - Special '$' variables, echo, render, surface, search , version, version_num, parent_module(n) and $parent_modules, assert
* User-Defined Functions and Modules - Functions, Modules, Children
* Debugging aids - % # ! * echo
* External libraries and code files
** include - SCAD, CSG
** use - SCAD
** import - STL, OFF, DXF
*** import_dxf - Deprecated
*** import_stl - Deprecated
** export - STL, OFF, AMF, 3MF, DXF, SVG, PNG, CSG
** surface - PNG

# Work in progress

This section contains documentation about ongoing work which is available as experimental features in snapshot versions of OpenSCAD or not yet integrated at all and pending in a branch or pull-request at the OpenSCAD github repository.
* Work in progress
Please add {{alphabetical}} only to book title pages.

# Contents

OpenSCAD User Manual without The OpenSCAD Language Reference
* First Steps
* The OpenSCAD User Interface
* Commented Example Projects
* Export
* Using an external Editor with OpenSCAD
* Using OpenSCAD in a command line environment
* Path locations
* Building OpenSCAD from Sources
** Building on Linux/UNIX
** Cross-compiling for Windows on Linux or Mac OS X
** Building on Windows
** Building on Mac OS X
* Frequently Asked Questions
* Libraries
* Glossary

# Chapter 1 -- First Steps

OpenSCAD User Manual
// Rim Cover Design in OpenSCAD
// Set the number of facets for smooth circles
$fn = 100;
// Convert inches to millimeters (1 inch = 25.4 mm)
inch = 25.4;
// Dimensions
rim_diameter = 18 * inch; // 18 inches in mm
cover_diameter = rim_diameter + (1 * inch); // Add overlap
thickness = 0.3 * inch; // Thickness of the cover
center_bore_diameter = 70; // Center hub diameter in mm
bolt_circle_diameter = 114.3; // Common 5-lug pattern (4.5 inches in mm)
bolt_hole_diameter = 16.5; // Bolt hole diameter in mm
// Main Rim Cover
module rim_cover {
difference {
// Outer disc
cylinder(d = cover_diameter, h = thickness, center = true);
// Center bore hole
translate([0, 0, 0])
cylinder(d = center_bore_diameter, h = thickness + 2, center = true);
// Bolt holes
for (i = [0 : 72 : 288]) {
rotate([0, 0, i])
translate([bolt_circle_diameter / 2, 0, 0])
cylinder(d = bolt_hole_diameter, h = thickness + 2, center = true);
// Decorative Pattern (Optional)
module decorative_pattern {
// Example: Raised curved blades between bolt holes
for (i = [0 : 72 : 288]) {
rotate([0, 0, i])
translate([bolt_circle_diameter / 2 + 30, 0, thickness / 2])
rotate([90, 0, 0])
cylinder(d1 = 0, d2 = 40, h = 20, center = true);
// Combine Rim Cover and Decorative Pattern
union {
rim_cover;
decorative_pattern; // Comment this line out if you don't want the pattern
color("blue") rim_cover;
color("gold") decorative_pattern;
translate([0, 0, thickness + 1])
linear_extrude(height=2)
text("Your Text Here", size=20, halign="center", valign="center");

### Compiling and rendering our first model

The cuboid can now be compiled and rendered by pressing F5 or F6 Function key on your keyboard while the OpenSCAD editor has focus. You should now see your object in the preview window as shown above.

### See also

Next: Positioning an object
Open one of the many examples that come with OpenSCAD (File, Examples). Or you can copy and paste this simple example into the OpenSCAD window:
* Usage example 1
* difference {
* cube(30, center=true);
* sphere(20);
* translate([0, 0, 30]) {
* cylinder(h=40, r=10);
Then press F5 to get a graphical preview of what you typed (or press F6 to get a graphical view).
You get three types of movement in the preview frame:
* Drag with left mouse button to rotate the view around the rotation center (view with ctrl-3) along the X and Z Axis. The bottom line changes the rotate values. (use shift while left-drag to rotate around X and Y )
* Drag with any other mouse button (or control-drag under OSX) to translate (move) the view. The bottom line changes translate values.
* Use the mouse scroll to zoom in and out. Alternatively you can use the + and - keys, or right-drag with the mouse while pressing a shift key (or control-shift-drag under OSX). The Viewport line at the bottom of the window shows a change in the distance value.

## See also

Previous: Model views
Next: [[../../The OpenSCAD User Interface/]]
We have already seen how to create a simple cuboid. Our next task is to attempt to use the translate positioning command to place an identical cuboid next to the existing cuboid. Type the data as shown below. There are a total of 4 lines of code. Press F5 or F6 function key when done to see the preview.
| Usage example 1 - positioning an object: |
| cube([2,3,4]); translate([3,0,0]) { cube([2,3,4]); } | OpenSCAD positioning an object |

### There is no semicolon following the translate command

Notice that there is no semicolon following the translate command. This is because the translate command relates to the following object. If the semicolon was in place, then the effect of the position translation would end, and the second cuboid would be placed at the same position as the first cuboid.

### See Also

Previous: Creating a simple model
Next: Changing the color of an object
We can change the color of an object by giving it RGB values. Instead of the traditional RGB values from 0 to 255 floating point values are used from 0.0 to 1.0. Note: changing the colors works only in Preview mode (F5); render mode (F6) does not currently support color.
| Usage example 1 - changing the color of an object: |
| color([1,0,0]) cube([2,3,4]); translate([3,0,0]) color([0,1,0]) cube([2,3,4]); translate([6,0,0]) color([0,0,1]) cube([2,3,4]); | OpenSCAD changing the color of an object |
Color names can be used in the 2011.12 version (and newer). The names are the same used for Web colors. For example: color("red") cube;
If you think of the entire command as a sentence, then color is an "adjective" that describes the "object" of the sentence (which is a "noun"). In this case, the object is the cube to be created. The adjective is placed before the noun in the sentence, like so: color cube;. In the same way, translate can be thought of as a "verb" that acts upon the object, and is placed like this: translate color cube;. The following code produces the same result:
If colors are nested, the outer-most color "wins" and over-rides any lower-level color statements.

### See Also

Previous: Positioning an object
Next: Model views
The "View" menu at the top of the OpenSCAD application window provides a variety of view options in the OpenSCAD model view window.

## Surfaces

The surface view is the initial model view that appears when the model code is first rendered. You can get back to this view by choosing "View >> Surfaces".

## Wireframe

Designers often choose "View >> Wireframe" when working with a particularly complex 3D model. The Wireframe view presents only a grid--the "scaffolding" beneath the surface. Think of the Eiffel Tower.
A wireframe is a visual presentation of a three dimensional or physical object. This method of modelling consists only of lines, points and curves defining the edges of an object. Using a wireframe model allows visualization of the underlying design structure of a 3D model. Since wireframe renderings are relatively simple and fast to calculate, they are often used in cases where a higher screen frame rate is needed (for instance, when working with a particularly complex 3D model, or in real-time systems that model exterior phenomena). When greater graphical detail is desired, surface textures can be added automatically after completion of the initial rendering of the wireframe. This allows the designer to quickly review changes or rotate the object to new desired views without long delays associated with more realistic rendering. The wireframe format is also well suited and widely used in programming tool paths for DNC (Direct Numerical Control) machine tools. Wireframe models are also used as the input for CAM (computer-Aided Manufacturing). Wireframe is the most abstract and least realistic of the three main CAD views.

## The OpenCSG view

Choosing "View >> OpenCSG" uses the open constructive solid geometry library to generate the model view utilizing OpenGL. If the OpenCSG library is not available or the video card or drivers do not support OpenGL, then this view does not produce visible output.

## The Thrown Together View

Choosing "View >> Thrown Together" overlays all the previous views together on the same screen. Importantly, objects subtracted by the difference command are rendered as solid objects in green (by default).

## See also

Previous: Changing the color of an object
Next: Opening an existing example model

## References

* ↑ "Wire-frame model". Wikipedia.

# Chapter 2 -- The OpenSCAD User Interface

OpenSCAD User Manual

## User Interface

The user interface of OpenSCAD has three parts
* The viewing area
* The console window
* The text editor

### Viewing area

Preview and rendering output goes into the viewing area. Using the Show Axes menu entry an indicator for the coordinate axes can be enabled.

### Console window

Status information, warnings and errors are displayed in the console window.
During a render a progress-bar is displayed at the bottom of the console. It includes a Cancel button to stop the render.

### Text editor

The built-in text editor provides basic editing features like text search & replace and also supports syntax highlighting. There are predefined color schemes that can be selected in the Preferences dialog.

## Interactive modification of the numerical value

It is possible to change a numeric value in the source code and observe the result in real time.
Placing the cursor after a digit and pressing Alt+ up arrow or Alt + down arrow will increment or decrement the chosen digit. The object is re-rendered and displayed in preview mode after each change of the selected number in the source code. The cursor is moved after the next digit by Alt + right arrow, the further decimal digits are added when needed by moving the cursor after the last digit on the right side. The cursor is moved left behind the most significant digits of the number by Alt + left arrow.
NOTE: On MacOS, use Option + Shift instead of Alt.
| Key | Description |
| Alt + Up Arrow | Increment the numeric value to the left of the cursor and preview the object. |
| Alt + Down Arrow | Decrement the numeric value to the left of the cursor and preview the object. |
| Alt + Left Arrow | Move the cursor left to more significant digit. |
| Alt + Right Arrow | Move the cursor right to less significant digit, eventually add one more decimal digit. |

## View navigation

The viewing area is navigated primarily using the mouse:
| Action | Icons | Description |
| rotating the view | | Dragging with the left mouse button rotates the view along the axes of the viewing area. It preserves the vertical axis' direction. Double-click the left button to set the point of rotation. |
| rotating the view | ⇧ Shift + | Dragging with the left mouse button when the shift key is pressed rotates the view along the vertical axis and the axis pointing towards the user. |
| moving the viewing area | | Dragging with the right mouse button moves the viewing area. |
| zooming | | Using the scroll wheel |
| zooming | | Dragging with the middle mouse button |
| zooming | ⇧ Shift + | Dragging with the right or middle mouse button and the shift key pressed |
| zooming | ⇧ Shift + | Dragging with the right or middle mouse button and the shift key pressed |
| zooming | + and - | The keys + and - |
| show/hide rotation center | Ctrl+3 | Turn on or off the graphic showing the center of rotation. (It is always in the center of the viewing area). |
| rotation reset | Ctrl+0 | Rotation can be reset using the shortcut Ctrl+0. |
| translation reset | Ctrl + ⇧ Shift+0 | Translation can be reset using the shortcut Ctrl+⇧ Shift+0. |

## View setup

The viewing area can be configured to use different rendering methods and other options using the View menu. Most of the options described here are available using shortcuts as well.

### Render modes
#### OpenCSG (F9)

This method produces instantaneous results, but has low frame rates when working with highly nonconvex objects.
Selecting the OpenCSG mode using F9 switches to the last generated OpenCSG view, but does not re-evaluate the source code. You may want to use the Compile function (F5, found in the Design menu) to re-evaluate the source code, build the OpenCSG objects and then switch to OpenCSG view.

##### Implementation Details

In OpenCSG mode, the OpenCSG library is used for generating the visible model. This library uses advanced OpenGL features (2.0) like the Z buffer and does not require an explicit description of the resulting mesh – instead, it tracks how objects are to be combined. For example, when rendering a spherical dent in a cube, it first renders the cube on the graphics card and then render the sphere, but instead of using the Z buffer to hide the parts of the sphere that are covered by the cube, it renders only those parts of the sphere, visually resulting in a cube with a spherical dent.

#### CGAL (Surfaces and Grid, F10 and F11)

This method might need some time when first used with a new program, but then has higher frame rates.
As before with OpenCSG, F10 and F11 enable only CGAL display mode and don't update the underlying objects; for that, use the Compile and Render function (F6, found in the Design menu).
To combine the benefits of those two display methods, you can selectively wrap parts of your program in a render function and force them to be baken into a mesh even with OpenCSG mode enabled.

##### Implementation Details

The acronym CGAL refers to The Open Source Computational Geometry Algorithms Library.
In CGAL mode, the CGAL library is used to compute the mesh of the root object, which is then displayed using simple OpenGL.

### View options
#### Show Edges (Ctrl+1)

If Show Edges is enabled, both OpenCSG and CGAL mode render edges as well as faces; CGAL even shows vertices. In CGAL grid mode, this option has no effect.
Enabling this option shows the difference between OpenCSG and CGAL quite clearly: While in CGAL mode you see an edge drawn everywhere it "belongs", OpenCSG does not show edges resulting from boolean operations – this is because they were never explicitly calculated but are just where one object's Z clipping begins or ends.

#### Show Axes (Ctrl+2)

If Show Axes is enabled, the origin of the global coordinate system is indicated by an orthogonal axes indicator. Additionally, a smaller axes indicator with axes names are shown in the lower left corner of the viewing area. The smaller axes indicator is marked x, y, z and coloured red, green, blue respectively.

#### Show Crosshairs (Ctrl+3)

If Show Crosshairs is enabled, the center of the viewport is indicated by four lines pointing in the room diagonal directions of the global coordinate system. This is useful when aligning the viewing area to a particular point in the model to keep it centered on screen during rotation.

### Animation

The Animate option adds an animation bar to the lower edge of the screen. As soon as FPS and Steps are set (reasonable values to begin with are 10 and 100, respectively), the current Time is incremented by 1/Steps, FPS times per second, until it reaches 1, when it wraps back to 0.
Every time Time is changed, the program is re-evaluated with the variable $t set to the current time. Read more about how $t is used in section Other_Language_Features.

### View alignment

The menu items Top, Bottom, …, Diagonal and Center (Ctrl+4, Ctrl+5, …, Ctrl+0, Ctrl+Shift+0) align the view to the global coordinate system.
Top, Bottom, Left, Right, Front and Back align it in parallel to the axes, the Diagonal option aligns it diagonally as it is aligned when OpenSCAD starts.
The Center option puts the coordinate center in the middle of the screen (but not rotate the view).
By default, the view is in Perspective mode, meaning that distances far away from the viewer appear shorter, as seen in the real world eyes or cameras. When the view mode is changed to Orthogonal, visible distances do not depend on the camera distance (the view simulates a camera at an infinite distance with an infinite focal length). This is especially useful in combination with the Top etc. options described above, as these orthogonal views result in a 2D images similar to what one would see in an engineering drawing.

## Dodecahedron

| //create a dodecahedron by intersecting 6 boxes module dodecahedron(height) { scale([height,height,height]) //scale by height parameter { intersection{ //make a cube cube([2,2,1], center = true); intersection_for(i=[0:4]) //loop i from 0 to 4, and intersect results { //make a cube, rotate it 116.565 degrees around the X axis, //then 72*i around the Z axis rotate([0,0,72*i]) rotate([116.565,0,0]) cube([2,2,1], center = true); } } } } //create 3 stacked dodecahedra //call the module with a height of 1 and move up 2 translate([0,0,2])dodecahedron(1); //call the module with a height of 2 dodecahedron(2); //call the module with a height of 4 and move down 4 translate([0,0,-4])dodecahedron(4); | The Dodecahedron as rendered from the example. |

## Icosahedron

An icosahedron can be created from three orthogonal golden-ratio rectangles inside a hull operation, where the golden ratio is $\varphi ={\frac {{\sqrt {5}}+1}{2}}$.
| phi=0.5*(sqrt(5)+1); // golden ratio // create an icosahedron by intersecting 3 orthogonal golden-ratio rectangles module icosahedron(edge_length) { st=0.0001; // microscopic sheet thickness hull { cube([edge_length*phi, edge_length, st], true); rotate([90,90,0]) cube([edge_length*phi, edge_length, st], true); rotate([90,0,90]) cube([edge_length*phi, edge_length, st], true); } } // display the 3 internal sheets alongside the icosahedron edge=10; translate([-20,0,0]) union { cube([edge*phi, edge, 0.01], true); rotate([90,90,0]) cube([edge*phi, edge, 0.01], true); rotate([90,0,90]) cube([edge*phi, edge, 0.01], true); } icosahedron(edge); | The icosahedron and its internal structure as rendered from the example. |
This icosahedron renders in an edge-up orientation. Rotating this icosahedron by $\arctan {\left({\frac {1}{\varphi }}\right)}$ about the Y-axis results in a vertex-up orientation. Rotating by ${\frac {1}{2}}\arccos {\left(-{\frac {\sqrt {5}}{3}}\right)}-90^{\circ }$ about the X-axis results in a face-up orientation. The edge length $L$ is related to the inner diameter $D_{i}$ (distance between opposite faces) by $L={\frac {D_{i}{\sqrt {3}}}{\varphi ^{2}}}$.

## Half-pyramid

An upside-down half-pyramid is a useful shape for 3D printing a support for an overhang protruding from a vertical wall. With sloping sides no steeper than 45°, no removable support structure needs to be printed.
While a half-pyramid can be made with a 4-sided cone (using the cylinder primitive) and subtracting a cube from half of it, the shape can be easily made in one operation by a scaled linear extrude of a rectangle having the middle of one edge on the origin.
| // Create a half-pyramid from a single linear extrusion module halfpyramid(base, height) { linear_extrude(height, scale=0.01) translate([-base/2, 0, 0]) square([base, base/2]); } halfpyramid(20, 10); | The half-pyramid as rendered from the example. |

## Bounding Box

| // Rather kludgy module for determining bounding box from intersecting projections module BoundingBox { intersection { translate([0,0,0]) linear_extrude(height = 1000, center = true, convexity = 10, twist = 0) projection(cut=false) intersection { rotate([0,90,0]) linear_extrude(height = 1000, center = true, convexity = 10, twist = 0) projection(cut=false) rotate([0,-90,0]) children(0); rotate([90,0,0]) linear_extrude(height = 1000, center = true, convexity = 10, twist = 0) projection(cut=false) rotate([-90,0,0]) children(0); } rotate([90,0,0]) linear_extrude(height = 1000, center = true, convexity = 10, twist = 0) projection(cut=false) rotate([-90,0,0]) intersection { rotate([0,90,0]) linear_extrude(height = 1000, center = true, convexity = 10, twist = 0) projection(cut=false) rotate([0,-90,0]) children(0); rotate([0,0,0]) linear_extrude(height = 1000, center = true, convexity = 10, twist = 0) projection(cut=false) rotate([0,0,0]) children(0); } } } // Test module on ellipsoid translate([0,0,40]) scale([1,2,3]) sphere(r=5); BoundingBox scale([1,2,3]) sphere(r=5); | Bounding Box applied to an Ellipsoid |

## Linear Extrude extended use examples
### Linear Extrude with Scale as an interpolated function

| //Linear Extrude with Scale as an interpolated function // This module does not need to be modified, // - unless default parameters want to be changed // - or additional parameters want to be forwarded (e.g. slices,...) module linear_extrude_fs(height=1,isteps=20,twist=0){ //union of piecewise generated extrudes union{ for(i = [ 0: 1: isteps-1]){ //each new piece needs to be adjusted for height translate([0,0,i*height/isteps]) linear_extrude( height=height/isteps, twist=twist/isteps, scale=f_lefs((i+1)/isteps)/f_lefs(i/isteps) ) // if a twist constant is defined it is split into pieces rotate([0,0,-(i/isteps)*twist]) // each new piece starts where the last ended scale(f_lefs(i/isteps)) obj2D_lefs; } } } // This function defines the scale function // - Function name must not be modified // - Modify the contents/return value to define the function function f_lefs(x) = let(span=150,start=20,normpos=45) sin(x*span+start)/sin(normpos); // This module defines the base 2D object to be extruded // - Function name must not be modified // - Modify the contents to define the base 2D object module obj2D_lefs{ translate([-4,-3]) square([9,12]); } //Top rendered object demonstrating the interpolation steps translate([0,0,25]) linear_extrude_fs(height=20,isteps=4); linear_extrude_fs(height=20); //Bottom rendered object demonstrating the inclusion of a twist translate([0,0,-25]) linear_extrude_fs(height=20,twist=90,isteps=30); | Example Linear Extrude of a rectangle with scale following part of a sine curve function |

### Linear Extrude with Twist as an interpolated function

| //Linear Extrude with Twist as an interpolated function // This module does not need to be modified, // - unless default parameters want to be changed // - or additional parameters want to be forwarded (e.g. slices,...) module linear_extrude_ft(height=1,isteps=20,scale=1){ //union of piecewise generated extrudes union{ for(i = [ 0: 1: isteps-1]){ //each new piece needs to be adjusted for height translate([0,0,i*height/isteps]) linear_extrude( height=height/isteps, twist=f_left((i+1)/isteps)-f_left((i)/isteps), scale=(1-(1-scale)*(i+1)/isteps)/(1-(1-scale)*i/isteps) ) //Rotate to next start point rotate([0,0,-f_left(i/isteps)]) //Scale to end of last piece size scale(1-(1-scale)*(i/isteps)) obj2D_left; } } } // This function defines the twist function // - Function name must not be modified // - Modify the contents/return value to define the function function f_left(x) = let(twist=90,span=180,start=0) twist*sin(x*span+start); // This module defines the base 2D object to be extruded // - Function name must not be modified // - Modify the contents to define the base 2D object module obj2D_left{ translate([-4,-3]) square([12,9]); } //Left rendered object demonstrating the interpolation steps translate([-20,0]) linear_extrude_ft(height=30,isteps=5); linear_extrude_ft(height=30); //Right rendered object demonstrating the scale inclusion translate([25,0]) linear_extrude_ft(height=30,scale=3); | Example Linear Extrude of a rectangle with twist following part of a sine curve function |

### Linear Extrude with Twist and Scale as interpolated functions

| //Linear Extrude with Twist and Scale as interpolated functions // This module does not need to be modified, // - unless default parameters want to be changed // - or additional parameters want to be forwarded module linear_extrude_ftfs(height=1,isteps=20,slices=0){ //union of piecewise generated extrudes union{ for(i=[0:1:isteps-1]){ translate([0,0,i*height/isteps]) linear_extrude( height=height/isteps, twist=leftfs_ftw((i+1)/isteps)-leftfs_ftw(i/isteps), scale=leftfs_fsc((i+1)/isteps)/leftfs_fsc(i/isteps), slices=slices ) rotate([0,0,-leftfs_ftw(i/isteps)]) scale(leftfs_fsc(i/isteps)) obj2D_leftfs; } } } // This function defines the scale function // - Function name must not be modified // - Modify the contents/return value to define the function function leftfs_fsc(x)= let(scale=3,span=140,start=20) scale*sin(x*span+start); // This function defines the twist function // - Function name must not be modified // - Modify the contents/return value to define the function function leftfs_ftw(x)= let(twist=30,span=360,start=0) twist*sin(x*span+start); // This module defines the base 2D object to be extruded // - Function name must not be modified // - Modify the contents to define the base 2D object module obj2D_leftfs{ square([12,9]); } //Left rendered objects demonstrating the steps effect translate([0,-50,-60]) rotate([0,0,90]) linear_extrude_ftfs(height=50,isteps=3); translate([0,-50,0]) linear_extrude_ftfs(height=50,isteps=3); //Center rendered objects demonstrating the slices effect translate([0,0,-60]) rotate([0,0,90]) linear_extrude_ftfs(height=50,isteps=3,slices=20); linear_extrude_ftfs(height=50,isteps=3,slices=20); //Right rendered objects with default parameters translate([0,50,-60]) rotate([0,0,90]) linear_extrude_ftfs(height=50); translate([0,50,0]) linear_extrude_ftfs(height=50); | Example Linear Extrude of a rectangle with twist and scale following part of a sine curve function |

## Strandbeest

See the Strandbeest example here.

## Previous

Other 2D formats

## Next

Paths

### Command line usage

OpenSCAD can not only be used as a GUI, but also handles command line arguments.
OpenSCAD 2021.01 has these options:
OpenSCAD 2019.05 has these options:
OpenSCAD 2015.03-1 has these options:
OpenSCAD 2014.03+ has these options:
Openscad 2013.05 had these options:
Earlier releases had only these:
The usage on OpenSCAD version 2011.09.30 (now deprecated) was:

### Export options

When called with the -o option, OpenSCAD does not start the GUI, but executes the given file and exports to the output_file in a format depending on the extension (.stl / .off / .dxf, .csg).
Some versions use -s/-d/-o to determine the output file format instead; check with "openscad --help".
If the option -d is given in addition to an export command, all files accessed while building the mesh are written in the argument of -d in the syntax of a Makefile.
For at least 2015.03-2+, specifying the extension .echo causes openscad to produce a text file containing error messages and the output of all echo calls in filename as they would appear in the console window visible in the GUI. Multiple output files are not supported, so using this option you cannot also obtain the model that would have normally been generated.

#### Camera and image output

For 2013.05+, the option to output a .png image was added. There are two types of cameras available for the generation of images.
The first camera type is a 'gimbal' camera that uses Euler angles, translation, and a camera distance, like OpenSCAD's GUI viewport display at the bottom of the OpenSCAD window.
The second camera type is a 'vector' camera, with an 'eye' camera location vector and a 'lookat' center vector.
--imgsize x,y chooses the .png dimensions and --projection chooses orthogonal or perspective, as in the GUI.
By default, cmdline .png output uses Preview mode (f5) with OpenCSG. For some situations it may be desirable to output the full render, with CGAL. This is done by adding '--render' as an option.

### Constants

In order to pre-define variables, use the -D option. It can be given repeatedly. Each occurrence of -D must be followed by an assignment. Unlike normal OpenSCAD assignments, these assignments don't define variables, but constants, which cannot be changed inside the program, and can thus be used to overwrite values defined in the program at export time.
If you want to assign the -D variable to another variable, the -D variable MUST be initialized in the main .scad program
without the first line, val would be undefined.
The right hand sides can be arbitrary OpenSCAD expressions, including mathematical operations and strings.
Be aware that your shell (bash, cmd, etc.) parses the arguments before passing them to openscad, therefore you need to properly quote or escape arguments with special characters like spaces or quotation marks. For example to assign a string production to a quality parameter one has to ensure the " characters OpenSCAD expects aren't stripped by the shell. In bash one could write:
or from the Windows prompt:
or you may need to escape the inner quotes instead:
Note that this sort of double-escaping isn't necessary when executing OpenSCAD from another process that isn't using a shell, because each argument is passed separately. For example a Java application might start a process like so:

### Command to build required files

In a complex build process, some missing files required by an OpenSCAD file can be generated if they are defined in a Makefile. If OpenSCAD is given the option -m make, it starts make file the first time it tries to access a missing file.

### Processing all .scad files in a folder

Example to convert all the .scad in a folder into .stl:
In a folder with .scad files, make a .bat file with text:
If it closes without processing, check to set the PATH by adding openscad directory to:
Add the openscad directory to the list

### Makefile example

The -d and -m options only make sense together. (-m without -d would not consider modified dependencies when building exports, -d without -m would require the files to be already built for the first run that generates the dependencies.)
Here is an example of a basic Makefile that creates an .stl file from an .scad file of the same name:
When make my_example.stl is run for the first time, it finds no .deps files, and must depend on my_example.scad. Because my_example.stl is not yet preset, it gets created unconditionally. If OpenSCAD finds missing files, it calls make to build them, and it lists all used files in my_example.stl.deps.
When make my_example.stl is called subsequently, it finds and includes my_example.stl.deps and check if any of the files listed there, including my_example.scad, changed since my_example.stl was built, based on their time stamps. Only if that is the case, it builds my_example.stl again.

#### Automatic targets

When building similar .stl files from a single .scad file, there is a way to automate that too:
All objects that are supposed to be exported automatically have to be defined in base.scad in an own module with their future file name (without the ".stl"), and have a comment like "// make me" in the line of the module definition. The "TARGETS=" line picks these out of the base file and creates the file names. These are built when make all (or make, for short) is called.
As the convention from the last example is to create the .stl files from .scad files of the same base name, for each of these files, an .scad file must be generated. This is done in the "%.scad:" paragraph; my_example.scad is a simple OpenSCAD file:
The ".SECONDARY" line is there to keep make from deleting the generated .scad files. Its presence helps determine which files no longer need to be rebuilt; please post ideas about what exactly goes wrong there (or how to fix it better) on the talk page!

### Windows notes

On Windows, openscad.com should be called from the command line as a wrapper for openscad.exe. This is because Openscad uses the 'devenv' solution to the Command-Line/GUI output issue. Typing 'openscad' at the cmd.exe prompt calls the .com program wrapper by default.

### MacOS notes

On MacOS the binary is normally hidden inside the App folder. If OpenSCAD is installed in the global Applications folder, it can be called from command line like in the following example that just shows the OpenSCAD version:
Alternatively, you may create a symbolic link to the binary to make calls from the command line easier:
Now you can call openscad directly without having to type in the full path.
On some versions of MacOS, you might get the following error when attempting to run openscad via that link:
You can fix this by creating a wrapper script to invoke the executable directly:

# Chapter 3 -- Commented Example Projects

OpenSCAD User Manual

## Dodecahedron

| //create a dodecahedron by intersecting 6 boxes module dodecahedron(height) { scale([height,height,height]) //scale by height parameter { intersection{ //make a cube cube([2,2,1], center = true); intersection_for(i=[0:4]) //loop i from 0 to 4, and intersect results { //make a cube, rotate it 116.565 degrees around the X axis, //then 72*i around the Z axis rotate([0,0,72*i]) rotate([116.565,0,0]) cube([2,2,1], center = true); } } } } //create 3 stacked dodecahedra //call the module with a height of 1 and move up 2 translate([0,0,2])dodecahedron(1); //call the module with a height of 2 dodecahedron(2); //call the module with a height of 4 and move down 4 translate([0,0,-4])dodecahedron(4); | The Dodecahedron as rendered from the example. |

## Icosahedron

An icosahedron can be created from three orthogonal golden-ratio rectangles inside a hull operation, where the golden ratio is $\varphi ={\frac {{\sqrt {5}}+1}{2}}$.
| phi=0.5*(sqrt(5)+1); // golden ratio // create an icosahedron by intersecting 3 orthogonal golden-ratio rectangles module icosahedron(edge_length) { st=0.0001; // microscopic sheet thickness hull { cube([edge_length*phi, edge_length, st], true); rotate([90,90,0]) cube([edge_length*phi, edge_length, st], true); rotate([90,0,90]) cube([edge_length*phi, edge_length, st], true); } } // display the 3 internal sheets alongside the icosahedron edge=10; translate([-20,0,0]) union { cube([edge*phi, edge, 0.01], true); rotate([90,90,0]) cube([edge*phi, edge, 0.01], true); rotate([90,0,90]) cube([edge*phi, edge, 0.01], true); } icosahedron(edge); | The icosahedron and its internal structure as rendered from the example. |
This icosahedron renders in an edge-up orientation. Rotating this icosahedron by $\arctan {\left({\frac {1}{\varphi }}\right)}$ about the Y-axis results in a vertex-up orientation. Rotating by ${\frac {1}{2}}\arccos {\left(-{\frac {\sqrt {5}}{3}}\right)}-90^{\circ }$ about the X-axis results in a face-up orientation. The edge length $L$ is related to the inner diameter $D_{i}$ (distance between opposite faces) by $L={\frac {D_{i}{\sqrt {3}}}{\varphi ^{2}}}$.

## Half-pyramid

An upside-down half-pyramid is a useful shape for 3D printing a support for an overhang protruding from a vertical wall. With sloping sides no steeper than 45°, no removable support structure needs to be printed.
While a half-pyramid can be made with a 4-sided cone (using the cylinder primitive) and subtracting a cube from half of it, the shape can be easily made in one operation by a scaled linear extrude of a rectangle having the middle of one edge on the origin.
| // Create a half-pyramid from a single linear extrusion module halfpyramid(base, height) { linear_extrude(height, scale=0.01) translate([-base/2, 0, 0]) square([base, base/2]); } halfpyramid(20, 10); | The half-pyramid as rendered from the example. |

## Bounding Box

| // Rather kludgy module for determining bounding box from intersecting projections module BoundingBox { intersection { translate([0,0,0]) linear_extrude(height = 1000, center = true, convexity = 10, twist = 0) projection(cut=false) intersection { rotate([0,90,0]) linear_extrude(height = 1000, center = true, convexity = 10, twist = 0) projection(cut=false) rotate([0,-90,0]) children(0); rotate([90,0,0]) linear_extrude(height = 1000, center = true, convexity = 10, twist = 0) projection(cut=false) rotate([-90,0,0]) children(0); } rotate([90,0,0]) linear_extrude(height = 1000, center = true, convexity = 10, twist = 0) projection(cut=false) rotate([-90,0,0]) intersection { rotate([0,90,0]) linear_extrude(height = 1000, center = true, convexity = 10, twist = 0) projection(cut=false) rotate([0,-90,0]) children(0); rotate([0,0,0]) linear_extrude(height = 1000, center = true, convexity = 10, twist = 0) projection(cut=false) rotate([0,0,0]) children(0); } } } // Test module on ellipsoid translate([0,0,40]) scale([1,2,3]) sphere(r=5); BoundingBox scale([1,2,3]) sphere(r=5); | Bounding Box applied to an Ellipsoid |

## Linear Extrude extended use examples
### Linear Extrude with Scale as an interpolated function

| //Linear Extrude with Scale as an interpolated function // This module does not need to be modified, // - unless default parameters want to be changed // - or additional parameters want to be forwarded (e.g. slices,...) module linear_extrude_fs(height=1,isteps=20,twist=0){ //union of piecewise generated extrudes union{ for(i = [ 0: 1: isteps-1]){ //each new piece needs to be adjusted for height translate([0,0,i*height/isteps]) linear_extrude( height=height/isteps, twist=twist/isteps, scale=f_lefs((i+1)/isteps)/f_lefs(i/isteps) ) // if a twist constant is defined it is split into pieces rotate([0,0,-(i/isteps)*twist]) // each new piece starts where the last ended scale(f_lefs(i/isteps)) obj2D_lefs; } } } // This function defines the scale function // - Function name must not be modified // - Modify the contents/return value to define the function function f_lefs(x) = let(span=150,start=20,normpos=45) sin(x*span+start)/sin(normpos); // This module defines the base 2D object to be extruded // - Function name must not be modified // - Modify the contents to define the base 2D object module obj2D_lefs{ translate([-4,-3]) square([9,12]); } //Top rendered object demonstrating the interpolation steps translate([0,0,25]) linear_extrude_fs(height=20,isteps=4); linear_extrude_fs(height=20); //Bottom rendered object demonstrating the inclusion of a twist translate([0,0,-25]) linear_extrude_fs(height=20,twist=90,isteps=30); | Example Linear Extrude of a rectangle with scale following part of a sine curve function |

### Linear Extrude with Twist as an interpolated function

| //Linear Extrude with Twist as an interpolated function // This module does not need to be modified, // - unless default parameters want to be changed // - or additional parameters want to be forwarded (e.g. slices,...) module linear_extrude_ft(height=1,isteps=20,scale=1){ //union of piecewise generated extrudes union{ for(i = [ 0: 1: isteps-1]){ //each new piece needs to be adjusted for height translate([0,0,i*height/isteps]) linear_extrude( height=height/isteps, twist=f_left((i+1)/isteps)-f_left((i)/isteps), scale=(1-(1-scale)*(i+1)/isteps)/(1-(1-scale)*i/isteps) ) //Rotate to next start point rotate([0,0,-f_left(i/isteps)]) //Scale to end of last piece size scale(1-(1-scale)*(i/isteps)) obj2D_left; } } } // This function defines the twist function // - Function name must not be modified // - Modify the contents/return value to define the function function f_left(x) = let(twist=90,span=180,start=0) twist*sin(x*span+start); // This module defines the base 2D object to be extruded // - Function name must not be modified // - Modify the contents to define the base 2D object module obj2D_left{ translate([-4,-3]) square([12,9]); } //Left rendered object demonstrating the interpolation steps translate([-20,0]) linear_extrude_ft(height=30,isteps=5); linear_extrude_ft(height=30); //Right rendered object demonstrating the scale inclusion translate([25,0]) linear_extrude_ft(height=30,scale=3); | Example Linear Extrude of a rectangle with twist following part of a sine curve function |

### Linear Extrude with Twist and Scale as interpolated functions

| //Linear Extrude with Twist and Scale as interpolated functions // This module does not need to be modified, // - unless default parameters want to be changed // - or additional parameters want to be forwarded module linear_extrude_ftfs(height=1,isteps=20,slices=0){ //union of piecewise generated extrudes union{ for(i=[0:1:isteps-1]){ translate([0,0,i*height/isteps]) linear_extrude( height=height/isteps, twist=leftfs_ftw((i+1)/isteps)-leftfs_ftw(i/isteps), scale=leftfs_fsc((i+1)/isteps)/leftfs_fsc(i/isteps), slices=slices ) rotate([0,0,-leftfs_ftw(i/isteps)]) scale(leftfs_fsc(i/isteps)) obj2D_leftfs; } } } // This function defines the scale function // - Function name must not be modified // - Modify the contents/return value to define the function function leftfs_fsc(x)= let(scale=3,span=140,start=20) scale*sin(x*span+start); // This function defines the twist function // - Function name must not be modified // - Modify the contents/return value to define the function function leftfs_ftw(x)= let(twist=30,span=360,start=0) twist*sin(x*span+start); // This module defines the base 2D object to be extruded // - Function name must not be modified // - Modify the contents to define the base 2D object module obj2D_leftfs{ square([12,9]); } //Left rendered objects demonstrating the steps effect translate([0,-50,-60]) rotate([0,0,90]) linear_extrude_ftfs(height=50,isteps=3); translate([0,-50,0]) linear_extrude_ftfs(height=50,isteps=3); //Center rendered objects demonstrating the slices effect translate([0,0,-60]) rotate([0,0,90]) linear_extrude_ftfs(height=50,isteps=3,slices=20); linear_extrude_ftfs(height=50,isteps=3,slices=20); //Right rendered objects with default parameters translate([0,50,-60]) rotate([0,0,90]) linear_extrude_ftfs(height=50); translate([0,50,0]) linear_extrude_ftfs(height=50); | Example Linear Extrude of a rectangle with twist and scale following part of a sine curve function |

## Strandbeest

See the Strandbeest example here.

## Previous

Other 2D formats

## Next

Paths

# Chapter 4 -- Export

OpenSCAD User Manual

### Export

After rendering with F6, the "File --> Export" menu can be used to export as STL, OFF, AMF, 3MF, DXF, SVG, CSG, PNG (image), or PDF.
Be sure to check the console window for error messages.
* STL, OFF and DXF are imported using import
* CSG can be imported using include<> or loaded like an SCAD file
* PNG can be imported using surface
* There are open pull requests for SVG and AMF, which require a bit more work/testing
* The file suffix is used to determine type

### STL Export

To export your design, select "Export as STL..." from the "File --> Export" menu, then enter a filename in the ensuing dialog box. Don't forget to add the ".stl" extension.
Trouble shooting:
After compile and render CGAL (F6), you may see that your design is simple: no. That's bad news.
See line 8 in the following output from OpenSCAD 2010.02:
When you try to export this to .STL, this message appears:
"Manifold" means that it is "water tight" and that there are no holes in the geometry. In a valid 2-manifold each edge must connect exactly two facets. That means that the program must be able to connect a face with an object. E.g. if you use a cube of height 10 to carve out something from a wider cube of height 10, it is not clear to which cube the top or the bottom belongs. So make the small extracting cube a bit "longer" (or "shorter"):
Here is a more tricky little example taken from the OpenSCAD Forum (retrieved 15:13, 22 March 2010 (UTC)):
Example1 would render like this:
The example1 module is not a valid 2-manifold because both cubes are sharing one edge. They touch each other but do not intersect.
Example2 is a valid 2-manifold because there is an intersection. Now the construct meets the 2-manifold constraint stipulating that each edge must connect exactly two facets.
Pieces you are subtracting must extend past the original part. (OpenSCAD Tip: Manifold Space and Time, retrieved 18:40, 22 March 2010 (UTC)).
For reference, another situation that causes the design to be non-exportable is when two faces that are each the result of a subtraction touch. Then the error message comes up.
simply touching surfaces is correctly handled.
- STL, OFF, AMF, DXF, SVG, CSG, PNG
With the import and extrusion modules it is possible to convert 2D objects read from DXF files to 3D objects. See also 2D to 3D Extrusion.

### Linear Extrude

Example of linear extrusion of a 2D object imported from a DXF file.

### Rotate Extrude

Example of rotational extrusion of a 2D object imported from a DXF file.

### Getting Inkscape to work

Inkscape is an open source drawing program. Tutorials for transferring 2d DXF drawings from Inkscape to OpenSCAD are available here:
* http://repraprip.blogspot.com/2011/05/inkscape-to-openscad-dxf-tutorial.html (Very simple, needs path segments to be straight lines)
* http://tonybuser.com/?tag=inkscape (More complicated, involves conversion to Postscript)
* http://bobcookdev.com/inkscape/inkscape-dxf.html (Better DXF Export, native support for bezier curves)
* http://www.bigbluesaw.com/saw/big-blue-saw-blog/general-updates/big-blue-saws-dxf-export-for-inkscape.html (even better support, works as of 10/29/2014, see link below registration window. Note: As of 6/17/15 only works with version 0.48.5 or earlier of inkscape, due to a breaking change made in 0.91.)
* http://www.instructables.com/id/Convert-any-2D-image-to-a-3D-object-using-OpenSCAD/ (Convert any 2D image to a 3D object using OpenSCAD)
* http://carrefour-numerique.cite-sciences.fr/fablab/wiki/doku.php?id=projets:de_inkscape_a_openscad (French, directly exports OpenSCAD file)

## Previous

CSG Export

## Next

Other 2D formats
Currently, OpenSCAD supports DXF only as a graphics format for 2D graphics. Other common formats are PS/EPS, SVG and AI.

### PS/EPS

The pstoedit program can convert between various vector graphics formats. OpenSCAD needs the -polyaslines option passed to the dxf output plugin to understand the file. The -mm option sets one mm to be one unit in the dxf; include this if you use one unit in OpenSCAD as equal to one millimeter. The -dt options instructs pstoedit to render texts, which is usually what you want if you include text. (If the rendered text's resolution in terms of polygon count is too low, the easiest solution is to scale up the eps before converting; if you know a more elegant solution, please add it to the example.)

### SVG

Inkscape can convert SVG to EPS. Then pstoedit can convert the EPS to DXF.

### Makefile automation

The conversion can be automated using the make system; put the following lines in your Makefile:
The first line specifies which dxf files are to be generated when make is called in the current directory. The second paragraph specifies how to convert a file ending in .svg to a file ending in .eps, and the third from .eps to .dxf.
A more complete makefile could autogenerate dxf files from the any svg in the folder. In which case, put the following lines into your Makefile:
It's still possible to call make filename.dxf to build a particular file, but this code also allows for (re)building of all dxf files in a folder just by calling make or make all.
This code is also universal enough that it's possible to put the code in a single file and symlink every makefile in any directory that has svg files for dxf conversion by running:
in each respective directory.

### AI (Adobe Illustrator)

Although Adobe Illustrator CC/CC.2014 allows you to export illustrations as DXF (and select DXF format versions as early as 12), it uses DXF entities that are not supported by OpenSCAD, such as POLYLINE and SPLINE.
Since pstoedit does not natively support Adobe Illustrator files, one alternative is to use EXDXF, which is an Adobe Illustrator plug-in (30 free trial exports and then you have to pay $90 to register the plugin).
Before exporting, it is recommended that you ensure that your Artboard is the same dimensions as the component you are exporting. Although EXDXF provides you with numerous options when exporting to DXF the most important option for OpenSCAD compliance is to set Line Conversion to Line and Arc.
OpenSCAD doesn't always provide information about the issues it encountered with a DXF import. If this happens, select Design | Flush Caches and then Design | Reload and Compile.

## Previous

DXF Extrusion

## Next

Short and Commented Example Projects

# Chapter 5 -- Using an external Editor with OpenSCAD

OpenSCAD User Manual

## Why use an external editor

Many people prefer to use a certain editor. They are used to the feature set and know the keybindings. OpenSCADs editor is functional and simple but might lack features people know from other editors. Moreover, external editor allows to use different monitors for editing and preview.
A relatively recent benefit is that many of the more powerful external editors can act as a client for an OpenSCAD language server, permitting IDE-style functionality such as inline error/warning displays, module/function documentation on hover, jump to module/function definition, find module/function references, code reformatting, etc. There are a handful of OpenSCAD language servers in various levels of development, currently the openscad-lsp language server provides the most features.

## How to use an external editor

OpenSCAD is able to check for changes of files and automatically recompile if a file change occurs. To use this feature enable "Design->Automatic Reload and Preview"
Once the feature is activated, just load the scad file within OpenSCAD as usual ("File->Open.."). After that, open the scad file in your favorite editor too. Edit and work on the scad file within the external editor. Whenever the file is saved to disk (from within the external editor), OpenSCAD recognizes the file change and automatically recompiles accordingly.
The internal editor can be hidden by minimizing the frame with the mouse or by selecting "View->Hide editor".

## Support of external editors

In principle all editors can be used. Some even have extensions/modes to provide features for OpenSCAD.
* Atom: There is a Language OpenSCAD package for Atom that provides highlighting and snippets.
* Emacs: OpenSCAD provides an emacs mode for OpenSCAD files. Use the link or install scad-mode via emacs package management (ELPA) with the MELPA repository.
* Geany: cobra18t provides a Geany syntax file for OpenSCAD. See Instructions tab in Thingiverse to install it.
* Gedit: Andy Turner provides a Gedit syntax file for OpenSCAD.
* IntelliJ: has an 'OpenSCAD Language Support' plugin.
* Kate: nerd256 provides a kate syntax file for OpenSCAD. See Instructions tab in Thingiverse to install it. You could create also a kate External tool to open OpenSCAD with the current file with script openscad %directory/%filename
* Neovim: An example configuration including basic linting and formatting is available via OpenSCAD in Neovim
* Notepad++: TheHeadlessSourceMan provides a Notepad++ syntax file for OpenSCAD. See Instructions tab in Thingiverse to install it.
* OpenSCADitor: OpenSCAD-dedicated editor
* Pulsar: Pulsar has the language-openscad package to provide highlighting and snippets.
* Sublime: Syntax highlighting and Customizer support
* Textmate: Syntax highlighting and Customizer support
* VIM: vim.org provides a VIM syntax file for OpenSCAD.
* Visual Studio Code and its FOSS build, VSCodium, have multiple OpenSCAD extensions available, providing highlighting, autocomplete, go to definition, code formatting, preview and more. Type "OpenSCAD" into the View > Extensions panel search box to find and install.

## Additional benefits

Besides using your editor of choice, these solutions enable the flexible usage of multi-monitor set-ups. One can have one monitor set up to depict the 3D object on the entire screen and a second monitor for the editor and other tools.

# Chapter 6 -- Using OpenSCAD in a command line environment

OpenSCAD User Manual

### Command line usage

OpenSCAD can not only be used as a GUI, but also handles command line arguments.
OpenSCAD 2021.01 has these options:
OpenSCAD 2019.05 has these options:
OpenSCAD 2015.03-1 has these options:
OpenSCAD 2014.03+ has these options:
Openscad 2013.05 had these options:
Earlier releases had only these:
The usage on OpenSCAD version 2011.09.30 (now deprecated) was:

### Export options

When called with the -o option, OpenSCAD does not start the GUI, but executes the given file and exports to the output_file in a format depending on the extension (.stl / .off / .dxf, .csg).
Some versions use -s/-d/-o to determine the output file format instead; check with "openscad --help".
If the option -d is given in addition to an export command, all files accessed while building the mesh are written in the argument of -d in the syntax of a Makefile.
For at least 2015.03-2+, specifying the extension .echo causes openscad to produce a text file containing error messages and the output of all echo calls in filename as they would appear in the console window visible in the GUI. Multiple output files are not supported, so using this option you cannot also obtain the model that would have normally been generated.

#### Camera and image output

For 2013.05+, the option to output a .png image was added. There are two types of cameras available for the generation of images.
The first camera type is a 'gimbal' camera that uses Euler angles, translation, and a camera distance, like OpenSCAD's GUI viewport display at the bottom of the OpenSCAD window.
The second camera type is a 'vector' camera, with an 'eye' camera location vector and a 'lookat' center vector.
--imgsize x,y chooses the .png dimensions and --projection chooses orthogonal or perspective, as in the GUI.
By default, cmdline .png output uses Preview mode (f5) with OpenCSG. For some situations it may be desirable to output the full render, with CGAL. This is done by adding '--render' as an option.

### Constants

In order to pre-define variables, use the -D option. It can be given repeatedly. Each occurrence of -D must be followed by an assignment. Unlike normal OpenSCAD assignments, these assignments don't define variables, but constants, which cannot be changed inside the program, and can thus be used to overwrite values defined in the program at export time.
If you want to assign the -D variable to another variable, the -D variable MUST be initialized in the main .scad program
without the first line, val would be undefined.
The right hand sides can be arbitrary OpenSCAD expressions, including mathematical operations and strings.
Be aware that your shell (bash, cmd, etc.) parses the arguments before passing them to openscad, therefore you need to properly quote or escape arguments with special characters like spaces or quotation marks. For example to assign a string production to a quality parameter one has to ensure the " characters OpenSCAD expects aren't stripped by the shell. In bash one could write:
or from the Windows prompt:
or you may need to escape the inner quotes instead:
Note that this sort of double-escaping isn't necessary when executing OpenSCAD from another process that isn't using a shell, because each argument is passed separately. For example a Java application might start a process like so:

### Command to build required files

In a complex build process, some missing files required by an OpenSCAD file can be generated if they are defined in a Makefile. If OpenSCAD is given the option -m make, it starts make file the first time it tries to access a missing file.

### Processing all .scad files in a folder

Example to convert all the .scad in a folder into .stl:
In a folder with .scad files, make a .bat file with text:
If it closes without processing, check to set the PATH by adding openscad directory to:
Add the openscad directory to the list

### Makefile example

The -d and -m options only make sense together. (-m without -d would not consider modified dependencies when building exports, -d without -m would require the files to be already built for the first run that generates the dependencies.)
Here is an example of a basic Makefile that creates an .stl file from an .scad file of the same name:
When make my_example.stl is run for the first time, it finds no .deps files, and must depend on my_example.scad. Because my_example.stl is not yet preset, it gets created unconditionally. If OpenSCAD finds missing files, it calls make to build them, and it lists all used files in my_example.stl.deps.
When make my_example.stl is called subsequently, it finds and includes my_example.stl.deps and check if any of the files listed there, including my_example.scad, changed since my_example.stl was built, based on their time stamps. Only if that is the case, it builds my_example.stl again.

#### Automatic targets

When building similar .stl files from a single .scad file, there is a way to automate that too:
All objects that are supposed to be exported automatically have to be defined in base.scad in an own module with their future file name (without the ".stl"), and have a comment like "// make me" in the line of the module definition. The "TARGETS=" line picks these out of the base file and creates the file names. These are built when make all (or make, for short) is called.
As the convention from the last example is to create the .stl files from .scad files of the same base name, for each of these files, an .scad file must be generated. This is done in the "%.scad:" paragraph; my_example.scad is a simple OpenSCAD file:
The ".SECONDARY" line is there to keep make from deleting the generated .scad files. Its presence helps determine which files no longer need to be rebuilt; please post ideas about what exactly goes wrong there (or how to fix it better) on the talk page!

### Windows notes

On Windows, openscad.com should be called from the command line as a wrapper for openscad.exe. This is because Openscad uses the 'devenv' solution to the Command-Line/GUI output issue. Typing 'openscad' at the cmd.exe prompt calls the .com program wrapper by default.

### MacOS notes

On MacOS the binary is normally hidden inside the App folder. If OpenSCAD is installed in the global Applications folder, it can be called from command line like in the following example that just shows the OpenSCAD version:
Alternatively, you may create a symbolic link to the binary to make calls from the command line easier:
Now you can call openscad directly without having to type in the full path.
On some versions of MacOS, you might get the following error when attempting to run openscad via that link:
You can fix this by creating a wrapper script to invoke the executable directly:

# Chapter 7 -- Path locations

OpenSCAD User Manual OpenSCAD looks for and saves resources to various paths. This is an overview.

## Env variables

* HOME
* XDG_CONFIG_HOME
* OPENSCAD_FONT_PATH
* OPENSCADPATH

## Per platform roots

* ResourcesPath
** Posix:
** Mac OS X: OpenSCAD.app/Contents/Resources
*** Windows:
* DocumentsPath
** Posix: $HOME/.local/share
** Mac OS X: [NSDocumentDirectory], typically $HOME/Documents
** Windows XP: [CSIDL_PERSONAL], typically C:users\\username\documents\GitHub\OpenScad\
** Windows Vista->: [CSIDL_PERSONAL], typically C:\users\username\documents\GitHub\OpenScad\
* UserConfigPath
** Posix: $XDG_CONFIG_HOME/OpenSCAD or $HOME/.config/OpenSCAD
** Mac: [NSApplicationSupportDirectory], typically $HOME/Library/Application Support/OpenSCAD
** Windows: [CSIDL_LOCAL_APPDATA], typically C:\Documents and Settings\username\Local Settings\Application Data

## Read-only Resources

* libraries: [ResourcesPath]/libraries
* fonts: [ResourcesPath]/fonts
* render color schemes: [ResourcesPath]/color-schemes/render
* editor color schemes: [ResourcesPath]/color-schemes/editor

## User Resources

* libraries: $OPENSCADPATH, [DocumentsPath]/OpenSCAD/libraries
* fonts
* render color schemes: [UserConfigPath]/color-schemes/render
* editor color schemes: [UserConfigPath]/color-schemes/editor

## Misc Resources

* GUI preferences (Uses QSettings):
* backups: [DocumentsPath]/OpenSCAD/backups

## Reference

this chapter is based on https://github.com/openscad/openscad/wiki/Path-locations written by the developer kintel

# Chapter 8 -- Building OpenSCAD from Sources

OpenSCAD User Manual

## Prebuilt binary packages

If you are lucky, you won't have to build it. Many Linux and BSD systems have pre-built OpenSCAD packages including Debian, Ubuntu, Fedora, Arch, NetBSD and OpenBSD. Check your system's package manager for details.

### generic linux binary package

There is also a generic linux binary package at http://www.openscad.org that can be unpacked and run from within most linux systems. It is self contained and includes the required libraries.

### nightly builds

see https://build.opensuse.org/package/show/home:t-paul/OpenSCAD

### chrysn's Ubuntu packages

For Ubuntu systems you can also try chrysn's Ubuntu packages at his launchpad PPA, or you can just copy/paste the following onto the command line:
His repositories for OpenSCAD and OpenCSG are here and here.

## Building OpenSCAD yourself

If you wish to build OpenSCAD for yourself, start by installing git on your system using your package manager. Git is sometimes packaged under the name 'scmgit' or 'git-core'. Then, use git to download the OpenSCAD source code
Then get the MCAD library, which is now included with OpenSCAD binary distributions

### Installing dependencies

OpenSCAD uses a large number of third-party libraries and tools. These are called dependencies. An up to date list of dependencies can usually be found in the README.md in openscad's main directory, here: https://github.com/openscad/openscad/ A brief list follows:
Eigen, GCC or Clang, Bison, Flex, CGAL, Qt, GMP, MPFR, boost, cmake, OpenCSG, GLEW, QScintilla, glib2, harfbuzz, freetype2, pkg-config, fontconfig

#### Prepackaged dependencies

Most systems are set up to install pre-built dependencies using a 'package manager', such as apt on ubuntu or pacman on Arch Linux. OpenSCAD comes with a 'helper script' that attempts to automatically run your package manager for you and download and install these pre-built packages if they exist. Note you must be running as root and/or using sudo to try this. Note that these scripts are likely to fail on Sun, Solaris, AIX, IRIX, etc (skip to the 'building dependencies' section below).

#### Verifying dependencies

After attempting to install dependencies, you should double check them. Exit any shells and perhaps reboot.
Now verify that the version numbers are up to those listed in openscad/README.md file. Also verify that no packages were accidentally missed. For example open a shell and run 'flex --version' or 'gcc --version'. These are good sanity checks to make sure your environment is proper.
OpenSCAD comes with another helper script that attempts to automate this process on many Linux and BSD systems (Again, it won't work on Sun/Solaris/Irix/AIX/etc).
If you cannot verify that your dependencies are installed properly and of a sufficient version, then you may have to install some 'by hand' (see the section below on building your own dependencies).
If your system has all the proper versions of dependencies, then continue to the 'Building OpenSCAD' section.

### Building the dependencies yourself

On systems that lack updated dependency libraries or tools, you must to download each and build it and install it by hand. You can do this by downloading and following installation instructions for each package separately. However OpenSCAD comes with scripts that attempt to automate this process on Linux and BSD systems, by installing everything into a folder created under $HOME/openscad_deps. This script does not build typical development dependencies like X11, Qt4, gcc, bash etc. But it attempts things like OpenCSG, CGAL, boost, etc.
To run the automated script, first set up the environment variables (if you don't use bash, replace "source" with a single ".")
Then, run a second script to download and build.
(If you only need CGAL or OpenCSG, you can just run ' ./scripts/uni-build-dependencies.sh cgal' or opencsg and it builds only a single library.)
The complete download and build process can take several hours, depending on your network connection speed and system speed. It is recommended to have at least 2 Gigabyte of free disk space to do the full dependency build. Each time you log into a new shell and wish to re-compile OpenSCAD you need to re-run the 'source scripts/setenv-unibuild.sh' script.
After completion, return to the section above on 'verifying dependencies' to see if they installed correctly.

### Build the OpenSCAD binary

Once you have installed your dependencies, you can build OpenSCAD.
You can also install OpenSCAD to /usr/local/ if you wish. The 'openscad' binary is put under /usr/local/bin, the libraries and examples reside under something like /usr/local/share/openscad possibly depending on your system. Note that if you have previously installed a binary linux package of openscad, you should take care to delete /usr/local/lib/openscad and /usr/local/share/openscad because they are not the same paths as what the standard qmake-built 'install' target uses.
   * Note: on Debian-based systems create a package and install OpenSCAD using:
   * sudo checkinstall -D make install
If you prefer not to install you can run "./openscad" directly whilst still in the ~/openscad directory.

### Experimental

To enable the experimental features, remake the project with CONFIG+=experimental:
The -B is only required once (when you have changed the config).
The experimental features are disabled by default, even when explicitly build as experimental build.
When you successfully build, you find a "features" tab in the preferences, where you can enable individual experimental features.
Alternatively, you may add
as the first line of openscad.pro.

## Compiling the test suite

OpenSCAD comes with over 740 regression tests. To build and run them, it is recommended to first build the GUI version of OpenSCAD by following the steps above, including the downloading of MCAD. Then, from the same login, run these commands:
The file 'openscad/doc/testing.txt' has more information. Full test logs are under tests/build/Testing/Temporary. A pretty-printed index.html web view of the tests can be found under a machine-specific subdirectory thereof and opened with a browser.

## Troubleshooting

If you encounter any errors when building, please file an issue report at https://github.com/openscad/openscad/issues/ .

### Errors about incompatible library versions

This may be caused by old libraries living in /usr/local/lib like boost, CGAL, OpenCSG, etc, (often left over from previous experiments with OpenSCAD). You are advised to remove them. To remove, for example, CGAL, run rm -rf /usr/local/include/CGAL && rm -rf /usr/local/lib/*CGAL*. Then erase $HOME/openscad_deps, remove your openscad source tree, and restart fresh. As of 2013 OpenSCAD's build process does not advise nor require anything to be installed in /usr/local/lib nor /usr/local/include.
Note that CGAL depends on Boost and OpenCSG depends on GLEW - interdependencies like this can really cause issues if there are stray libraries in unusual places.
Another source of confusion can come from running from within an 'unclean shell'. Make sure that you don't have LD_LIBRARY_PATH set to point to any old libraries in any strange places. Also don't mix a Mingw windows cross build with your linux build process - they use different environment variables and may conflict.

### OpenCSG didn't automatically build

If for some reason the recommended build process above fails to work with OpenCSG, please file an issue on the OpenSCAD github. In the meantime, you can try building it yourself.
   * Note: on Debian-based systems (such as Ubuntu), you can add the 'install' target to the OpenCSG Makefile, and then use checkinstall to create a clean .deb package for install/removal/upgrade. Add this target to Makefile:
   * install:
   * # !! THESE LINES PREFIXED WITH ONE TAB, NOT SPACES !!
   * cp -d lib/lib* /usr/local/lib/
   * cp include/opencsg.h /usr/local/include/
   * ldconfig
   * Then:
   * sudo checkinstall -D make install
   * .. to create and install a clean package.

### CGAL didn't automatically build

If this happens, you can try to compile CGAL yourself. It is recommended to install to $HOME/openscad_deps and otherwise follow the build process as outlined above.

### Compiling fails with an Internal compiler error from GCC or GAS

This can happen if you run out of virtual memory, which means all of physical RAM as well as virtual swap space from the disk. See below under "horribly slow" for reasons. If you are non-root, there are a few things you can try. The first is to use the 'clang' compiler, as it uses much less RAM than gcc. The second thing is to edit the Makefile and remove the '-g' and '-pipe' flags from the compiler flags section.
If, on the other hand, you are root, then you can expand your swap space. On Linux this is pretty standard procedure and easily found in a web search. Basically you do these steps (after verifying you have no file named /swapfile already):
For permanent swap setup in /etc/fstab, instructions are easily found through web search. If you are building on an SSD (solid state drive) machine the speed of a swapfile allows a reasonable build time.

### Compiling is horribly slow and/or grinds the disk

It is recommended to have at least 1.5 Gbyte of RAM to compile OpenSCAD. There are a few workarounds in case you don't. The first is to use the experimental support for the Clang Compiler (described below) as Clang uses much less RAM than GCC. Another workaround is to edit the Makefile generated by qmake and search/replace the optimization flags (-O2) with -O1 or blank, and to remove any '-g' debug flags from the compiler line, as well as '-pipe'.
If you have plenty of RAM and just want to speed up the build, you can try a paralell multicore build with
Where 'x' is the number of cores you want to use. Remember you need x times the amount of RAM to avoid possible disk thrashing.
The reason the build is slow is because OpenSCAD uses template libraries like CGAL, Boost, and Eigen, which use large amounts of RAM to compile - especially CGAL. GCC may take up 1.5 Gigabytes of RAM on some systems during the build of certain CGAL modules. There is more information at StackOverflow.com.

### BSD issues

The build instructions above are designed to work unchanged on FreeBSD and NetBSD. However the BSDs typically require special environment variables set up to build any QT project - you can set them up automatically by running
NetBSD 5.x, requires a patched version of CGAL. It is recommended to upgrade to NetBSD 6 instead as it has all dependencies available from pkgin. NetBSD also requires the X Sets to be installed when the system was created (or added later).
On OpenBSD it may fail to build after running out of RAM. OpenSCAD requires at least 1 Gigabyte to build with GCC. You may have need to be a user with 'staff' level access or otherwise alter required system parameters. The 'dependency build' sequence has also not been ported to OpenBSD so you must rely on the standard OpenBSD system package tools (in other words you have to have root).

### Sun / Solaris / IllumOS / AIX / IRIX / Minix / etc

The OpenSCAD dependency builds have been mainly focused on Linux and BSD systems like Debian or FreeBSD. The 'helper scripts' are likely to fail on other types of Un*x. Furthermore the OpenSCAD build system files (qmake .pro files for the GUI, cmake CMakeFiles.txt for the test suite) have not been tested thoroughly on non-Linux non-BSD systems. Extensive work may be required to get a working build on such systems.

### Test suite problems

Headless server
The test suite tries to automatically detect if you have an X11 DISPLAY environment variable set. If not, it tries to automatically start Xvfb or Xvnc (virtual X framebuffers) if they are available.
If you want to run these servers manually, you can attempt the following:
Alternatively:
There are some cases where Xvfb/Xvnc won't work. Some older versions of Xvfb may fail and crash without warning. Sometimes Xvfb/Xvnc have been built without GLX (OpenGL) support and OpenSCAD won't be able to generate any images.
Image-based tests takes a long time, they fail, and the log says 'return -11'
Imagemagick may have crashed while comparing the expected images to the test-run generated (actual) images. You can try using the alternate ImageMagick comparison method by by erasing CMakeCache, and re-running cmake with -DCOMPARATOR=ncc. This enables the Normalized Cross Comparison method which is more stable, but possibly less accurate and may give false positives or negatives.
Testing images fails with 'morphology not found" for ImageMagick in the log
Your version of imagemagick is old. Upgrade imagemagick, or pass -DCOMPARATOR=old to cmake, otherwise the comparison reliability is reduced.

### I moved the dependencies I built and now openscad won't run

It isn't advised to move them because the build is using RPATH hard coded into the openscad binary. You may try to workaround by setting the LD_LIBRARY_PATH environment variable to place yourpath/lib first in the list of paths it searches. If all else fails, you can re-run the entire dependency build process but export the BASEDIR environment variable to your desired location, before you run the script to set environment variables.

## Tricks and tips
### Reduce space of dependency build

After you have built the dependencies you can free up space by removing the $BASEDIR/src directory - where $BASEDIR defaults to $HOME/openscad_deps.

### Preferences

OpenSCAD's config file is kept in ~/.config/OpenSCAD/OpenSCAD.conf.

### Setup environment to start developing OpenSCAD in Ubuntu 11.04

The following paragraph describes an easy way to setup a development environment for OpenSCAD in Ubuntu 11.04. After executing the following steps QT Creator can be used to graphically start developing/debugging OpenSCAD.
* Add required PPA repositories:
* Update and install required packages:
* Get the OpenSCAD sources:
* Build OpenSCAD using the command line:
* Build OpenSCAD using QT Creator:
Just open the project file openscad.pro (CTRL+O) in QT Creator and hit the build all (CTRL+SHIFT+B) and run button (CTRL+R).

### The Clang Compiler

There is experimental support for building with the Clang compiler under linux. Clang is faster, uses less RAM, and has different error messages than GCC. To use it, first of all you need CGAL of at least version 4.0.2, as prior versions have a bug that makes clang unusable. Then, run this script before you build OpenSCAD.
Clang support depends on your system's QT installation having a clang enabled qmake.conf file. For example, on Ubuntu, this is under /usr/share/qt4/mkspecs/unsupported/linux-clang/qmake.conf. BSD clang-building may require a good deal of fiddling and is untested, although eventually it is planned to move in this direction as the BSDs (not to mention OSX) are moving towards favoring clang as their main compiler.
OpenSCAD includes convenience scripts to cross-build Windows installer binaries using the MXE system (http://mxe.cc). If you wish to use them, you can first install the MXE Requirements such as cmake, perl, scons, using your system's package manager (click to view a complete list of requirements). Then you can perform the following commands to download OpenSCAD source and build a windows installer:
The x-build-dependencies process takes several hours, mostly to cross-build QT. It also requires several gigabytes of disk space. If you have multiple CPUs you can speed up things by running export NUMCPU=x before running the dependency build script. By default it builds the dependencies in $HOME/openscad_deps/mxe. You can override the mxe installation path by setting the BASEDIR environment variable before running the scripts. The OpenSCAD binaries are built into a separate build path, openscad/mingw32.
Note that if you want to then build linux binaries, you should log out of your shell, and log back in. The 'setenv' scripts, as of early 2013, required a 'clean' shell environment to work.
If you wish to cross-build manually, please follow the steps below and/or consult the release-common.sh source code.

## Setup

The easiest way to cross-compile OpenSCAD for Windows on Linux or Mac is to use mxe (M cross environment). You must install git to get it. Once you have git, navigate to where you want to keep the mxe files in a terminal window and run:
Add the following line to your ~/.bashrc file:
replacing <where mxe is installed> with the appropriate path.

## Requirements

The requirements to cross-compile for Windows are just the requirements of mxe. They are listed, along with a command for installing them here. You don't need to type 'make'; this makes everything and take up >10 GB of diskspace. You can instead follow the next step to compile only what's needed for openscad.
Now that you have the requirements for mxe installed, you can build OpenSCAD's dependencies (CGAL, Opencsg, MPFR, and Eigen2). Just open a terminal window, navigate to your mxe installation and run:
This can take a few hours, because it has to build things like gcc, qt, and boost. Just go calibrate your printer or something while you wait. To speed things up, you might want do something like "make -j 4 JOBS=2" for parallel building. See the mxe tutorial for more details.
Optional: If you want to build an installer, you need to install the nullsoft installer system. It should be in your package manager, called "nsis".

## Build OpenSCAD

Now that all the requirements have been met, all that remains is to build OpenSCAD itself. Open a terminal window and enter:
Then get MCAD:
You need to create a symbolic link here for the build system to find the libraries:
again replacing <where mxe is installed> with the appropriate path
Now to build OpenSCAD run:
This creates openscad.exe in ./release and you can build an installer with it as described in the instructions for building with Microsoft Visual C++, described here.
The difference is that instead of right-clicking on the *.nsi file you run:
Note that as of early 2013, OpenSCAD's 'scripts/release-common.sh' automatically uses the version of nsis that comes with the MXE cross build system, so you may wish to investigate the release-common.sh source code to see how it works, if you have troubles.
This is a set of instructions for building OpenSCAD with the Microsoft Visual C++ compilers. It has not been used since circa 2012 and is unlikely to work properly. It is maintained here for historical reference purposes.
A newer build is being attempted with the Msys2 system, please see http://en.wikibooks.org/wiki/OpenSCAD_User_Manual/Building_on_Microsoft_Windows
This MSVC build is as static as reasonable, with no external DLL dependencies that are not shipped with Windows
Note: It was last tested on the Dec 2011 build. Newer checkouts of OpenSCAD may not build correctly or require extensive modification to compile under MSVC. OpenSCAD releases of 2012 were typically cross-compiled from linux using the Mingw & MXE system. See Cross-compiling for Windows on Linux or Mac OS X.

## Downloads

start by downloading:
* Visual Studio Express http://download.microsoft.com/download/E/8/E/E8EEB394-7F42-4963-A2D8-29559B738298/VS2008ExpressWithSP1ENUX1504728.iso
* QT (for vs2008) http://get.qt.nokia.com/qt/source/qt-win-opensource-4.7.2-vs2008.exe
* git http://msysgit.googlecode.com/files/Git-1.7.4-preview20110204.exe
* glew https://sourceforge.net/projects/glew/files/glew/1.5.8/glew-1.5.8-win32.zip/download
* cmake http://www.cmake.org/files/v2.8/cmake-2.8.4-win32-x86.exe
* boost http://www.boostpro.com/download/boost_1_46_1_setup.exe
* cgal https://gforge.inria.fr/frs/download.php/27647/CGAL-3.7-Setup.exe
* OpenCSG http://www.opencsg.org/OpenCSG-1.3.2.tar.gz
* eigen2 http://bitbucket.org/eigen/eigen/get/2.0.15.zip
* gmp/mpfr http://holoborodko.com/pavel/downloads/win32_gmp_mpfr.zip
* MinGW http://netcologne.dl.sourceforge.net/project/mingw/Automated%20MinGW%20Installer/mingw-get-inst/mingw-get-inst-20110316/mingw-get-inst-20110316.exe

## Installing

* Install Visual Studio
** No need for siverlight or mssql express
** You can use a virtual-CD program like MagicDisc to mount the ISO file and install without using a CD
* Install QT
** Install to default location C:\Qt\4.7.2\
* Install Git
** Click Run Git and included Unix tools from the Windows Command Prompt despite the big red letters warning you not to.
* Install Cmake
** Check the 'Add cmake to the system path for the current user' checkbox
** Install to default location C:\Program Files\CMake 2.8
* Install Boost
** Select the VC++ 9.0 vs2008 radio
** Check the 'multithreaded static runtime' checkbox only
** Install into C:\boost_1_46_1\
* Install CGAL
** Note - CGAL 3.9 fixes several bugs in earlier versions of CGAL, but CGAL 3.9 does not compile under MSVC without extensive patching. Please keep that in mind when compiling OpenSCAD with MSVC - there may be bugs due to the outdated version of CGAL required to use MSVC.
** Note its not a binary distribution, just an installer that installs the source.
** No need for CGAL Examples and Demos
** Make sure mpfr and gmp precompiled libs is checked
** The installer wants you to put this in C:\Program Files\CGAL-3.7\ I used C:\CGAL-3.7\
** Make sure CGAL_DIR environment checked.
* Install MinGW
** Make sure you select the MSYS Basic System under components
* Extract downloaded win32_gmp_mpfr.zip file to C:\win32_gmp_mpfr\
* Replace the mpfr and gmp .h files in CGAL with the ones from win32_gmp_mpfr
** Delete, or move to a temp folder, all files in CGAL-3.7\auxiliary\gmp\include folder
** Copy all the .h files in C:\win32_gmp_mpfr\gmp\Win32\Release to CGAL-3.7\auxiliary\gmp\include
** Copy all the .h files in C:\win32_gmp_mpfr\mpfr\Win32\Release to CGAL-3.7\auxiliary\gmp\include
* Replace the mpfr and gmp libs in CGAL with the ones from win32_gmp_mpfr
** Delete, or move to a temp folder, all (06/20/2011 libmpfr-4.lib is needed 7/19/11 - i didnt need it) files in CGAL-3.7\auxiliary\gmp\lib folder.
** Copy C:\win32_gmp_mpfr\gmp\Win32\Release\gmp.lib to CGAL-3.7\auxiliary\gmp\lib
** Copy C:\win32_gmp_mpfr\mpfr\Win32\Release\mpfr.lib to CGAL-3.7\auxiliary\gmp\lib
** Go into CGAL-3.7\auxiliary\gmp\lib and copy gmp.lib to gmp-vc90-mt-s.lib, and mpfr.lib to mpfr-vc90-mt-s.lib (so the linker can find them in the final link of openscad.exe)
To get OpenSCAD source code:
* Open "Git Bash" (or MingW Shell) (the installer may have put a shortcut on your desktop). This launches a command line window.
* Type cd c: to change the current directory.
* Type git clone git://github.com/openscad/openscad.git This puts OpenSCAD source into C:\openscad\
Where to put other files:
I put all the dependencies in C:\ so for example,
* C:\eigen2\
* C:\glew-1.5.8\
* C:\OpenCSG-1.3.2\
.tgz can be extracted with tar -zxvf from the MingW shell, or Windows tools like 7-zip. Rename and move sub-directories if needed. I.e eigen-eigen-0938af7840b0 should become c:\eigen2, with the files like COPYING and CMakeLists.txt directly under it. c:\glew-1.5.8 should have 'include' and 'lib' directly under it.

## Compiling Dependencies

For compilation I use the QT Development Command Prompt
Start->Program Files->Qt by Nokia v4.7.2 (VS2008 OpenSource)->QT 4.7.2 Command Prompt

### Qt

Qt needs to be recompiled to get a static C runtime build. To do so, open the command prompt and do:
Configure takes several minutes to finish processing. After it is done, open up the file Qt\4.7.2\mkspecs\win32-msvc2008\qmake.conf and replace every instance of -MD with -MT. Then:
This takes a very, very long time. Have a nap. Get something to eat. On a Pentium 4, 2.8GHZ CPU with 1 Gigabyte RAM, Windows XP, it took more than 7 hours, (that was with -O2 turned off)

### CGAL

Now edit the CMakeCache.txt file. Replace every instance of /MD with /MT . Now, look for a line like this:
CMAKE_BUILD_TYPE:STRING=Debug
Change Debug to Release. Now re-run cmake
It should scroll by, watch for lines saying "--Building static libraries" and "--Build type: Release" to confirm the proper settings. Also look for /MT in the CXXFLAGS line. When it's done, you can do the build:
You should now have a CGAL-vc90-mt-s.lib file under C:\CGAL-3.7\lib . If not, see Troubleshooting, below.

### OpenCSG

Launch Visual Express.
* Manually step through project upgrade wizard
* Make sure the runtime library settings for all projects is for Release (not Debug)
** Click Build/Configuration Manager
** Select "Release" from "Configuration:" drop down menu
** Hit Close
* Make sure the runtime library setting for OpenCSG project is set to multi-threaded static
** Open the OpenCSG project properties by clicking menu item "Project->OpenCSG Properties" (might be just "Properties")
** Make sure it says "Active(Release)" in the "Configuration:" drop down menu
** Click 'Configuration Properties -> C/C++ -> Code Generation'
** Make sure "Runtime Library" is set to "Multi-threaded (/MT)"
** Click hit OK
* Make sure the runtime library setting for glew_static project is set to multi-threaded static
** In "Solution Explorer - OpenCSG" pane click "glew_static" project
** Open the OpenCSG project properties by clicking menu item "Project->OpenCSG Properties" (might be just "Properties")
** Make sure it says "Active(Release)" in the "Configuration:" drop down menu
** Click C/C++ -> Code Generation
** Make sure "Runtime Library" is set to "Multi-threaded (/MT)"
** Click hit OK
* Close Visual Express saving changes
Build OpenCSG library. You can use the GUI Build/Build menu (the Examples project might fail, but glew and OpenCSG should succeed). Alternatively you can use the command line:
The cmd /c bit is needed otherwise you return to the shell immediately and must wait for the build process to complete (there is no indication that this is happening apart from viewing in task manager).

### OpenSCAD

* Bison/Flex: Open the mingw shell and type mingw-get install msys-bison. Then do the same for flex: mingw-get install msys-flex
* Open the QT Shell, and copy/paste the following commands
Wait for the nmake to end. There are usually a lot of non-fatal warnings about the linker. On success, an openscad.exe file appears in the release folder. Enjoy.

## Building an installer

* Download and install NSIS from http://nsis.sourceforge.net/Download
* Put the FileAssociation.nsh macro from http://nsis.sourceforge.net/File_Association in the NSIS Include directory, C:\Program Files\NSIS\Include
* Run 'git submodule init' and 'git submodule update' to download the MCAD system (https://github.com/elmom/MCAD) into the openscad/libraries folder.
* Copy the OpenSCAD "libraries" and "examples" directory into the "release" directory
* Copy OpenSCAD's "scripts/installer.nsi" to the "release" directory.
* Right-click on the file and compile it with NSIS. It produces a nice, easy installer. Enjoy.

## Compiling the regression tests

* Follow all the above steps, build openscad, run it, and test that it basically works.
* Install Python 2.x (not 3.x) from http://www.python.org
* Install Imagemagick from http://www.imagemagick.org
* read openscad\docs\testing.txt
* Go into your QT shell
* This should produce a number of test .exe files in your directory. Now run
If you have link problems, see Troubleshooting, below.

## Troubleshooting

Linker errors
If you have errors during linking, the first step is to improve debug logging, and redirect to a file. Open Openscad.pro and uncomment this line:
Now rerun
You can use a program like 'less' (search with '/') or wordpad to review the log.
To debug these errors, you must understand basics about Windows linking. Windows links to its standard C library with basic C functions like malloc. But there are four different ways to do this, as follows:
All of the libraries that are link together in a final executable must be compiled with the same type of linking to the standard C library. Otherwise, you get link errors like, "LNK2005 - XXX is already defined in YYY". But how can you track down which library wasn't linked properly? 1. Look at the log, and 2. dumpbin.exe
dumpbin.exe
dumpbin.exe can help you determine what type of linking your .lib or .obj files were created with. For example, dumpbin.exe /all CGAL.lib | find /i "DEFAULTLIB" gives you a list of DEFAULTLIB symbols inside of CGAL.lib. Look for LIBCMT, LIBCMTD, MSVCRT, or MSVCRTD. That tells you, according to the above table, whether it was built Static Release, Static Debug, DLL Release, or DLL Debug. (DLL, of course means Dynamic Link Library in this conversation.) This can help you track down, for example, linker errors about conflicting symbols in LIBCMT and LIBCMTD.
dumpbin.exe can also help you understand errors involving unresolved external symbols. For example, if you get an error about unresolved external symbol ___GLEW_NV_occlusion_query, but your VERBOSE error log says the program linked in glew32.lib, then you can dumpbin.exe /all glew32.lib | find /i "occlusion" to see if the symbol is actually there. You may see a mangled symbol, with __impl, which gives you another clue with which you can google. In this particular example, glew32s.lib (s=static) should have been linked instead of glew32.lib.

### CGAL

CGAL-vc90-mt-s.lib
After compilation, it is possible that you might get a file named CGAL-vc90-mt.lib or CGAL-vc90-mt-gd.lib instead of CGAL-vc90-mt-s.lib. There are many possibilities: you accidentally built the wrong version, or you may have built the right version and VCExpress named it wrong. To double check, and fix the problem, you can do the following:
If this shows lines referencing LIBCMTD, MSVCRT, or MSVCRTD then you accidentally built the debug and/or dynamic version, and you need to clean the build, and try to build again with proper settings to get the multi-threaded static release version. However, if it just says LIBCMT, then you are probably OK. Look for another line saying DEFAULTLIB:CGAL-vc90-mt-s. If it is there, then you can probably just rename the file and have it work.
Visual Studio build
You can build CGAL using the GUI of visual studio, as an alternative to nmake. You have to use an alternate cmake syntax. Type 'cmake' by itself and it gives you a list of 'generators' that are valid for your machine; for example Visual Studio Express is cmake -G"Visual Studio 9 2008" .. That should get you a working .sln (solution) file.
Then run this:
Modify the build configure target to Release (not Debug) and change the properties of the projects to be '/MT' multithreaded static builds. This is the similar procedure used to build OpenCSG, so refer to those instructions above for more detail.
Note for Unix users
The 'MingW Shell' (Start/Programs) provide tools like bash, sed, grep, vi, tar, &c. The C:\ drive is under '/c/'. MingW has packages, for example: mingw-get install msys-unzip downloads and installs the 'unzip' program. Git contains some programs by default, like perl. The windows command shell has cut/paste - hit alt-space. You can also change the scrollback buffer settings.

### References

* Windows Building, OpenSCAD mailing list, 2011 May.
* C Run-Time Libraries linking, Microsoft.com for Visual Studio 8 (The older manual is good too, here)
* old nabble on _isatty, flex
* Windows vs. Unix: Linking dynamic load modules by Chris Phoenix
* Static linking in CMAKE under MS Visual C (cmake.org)
* __imp , declspec(dllimport), and unresolved references (stackoverflow.com)
For building OpenSCAD, see https://github.com/openscad/openscad/blob/master/README.md

# Chapter 9 -- Frequently Asked Questions

OpenSCAD User Manual

# General
## How is OpenSCAD pronounced?

The intended pronunciation is: Open - ESS - CAD

## What is the meaning of the S in OpenSCAD?

The S stands for Solid as Solid modeling.

## Using OpenSCAD for Windows in VM's or via Remote desktop (Windows RDP or Linux XfreeRDP etc)

It is likely that your VM or session does not support the required version of OpenCSG/OpenGL for correct OpenSCAD previews.
This can be resolved by use of software rendering via the Mesa driver from the MSYS2 package.
Download the Repo (the link at File: in the URLs below) for the 64-bit, or 32-bit version as appropriate for your Windows installation:
That file is a ...pkg.tar.xz compressed file, a format unsupported in Windows. Use 7-zip or WinRAR to extract the file contents.
Extract the file mingw[64 or 32]\bin\opengl32.dll, (the file is still named opengl32.dll for the 64bit version).
Copy opengl32.dll to the OpenSCAD installation directory, i.e. with the openscad.exe file, likely a sub-directory of c:\program files [for 64bits] or c:\program files(x86) [for 32bits].
Restart OpenSCAD and preview should function normally.

# Display
## Preview doesn't appear to work at all

Some systems, in particular Intel GPUs on Windows, tend to have old or broken OpenGL drivers. This affects preview rendering when using difference or intersection operators.
The following tends to improve the situation: Edit->Preferences->Advanced->Force Goldfeather (see screenshot).

## What are those strange flickering artifacts in the preview?

This is typically caused by differencing objects that share one or more faces, e.g.:
In some cases the final render works fine, but designs with coincident resulting faces should be considered a design with undefined behavior, as a proper render result is not guaranteed. The fundamental source of the issue is not a bug, but an intrinsic property of the inability to rigorously compare floating point values which might have undergone trigonometric operations (like rotations) resulting in irrational values that simply cannot be represented exactly in any manner. Because of this you can get near-coincident surfaces where part of the surface is inside and part of the surface is outside, or zero-volume regions, resulting in a render error that the output is not manifold. In simple tests like this example, the render will typically be okay giving false confidence in this approach, but if both pieces were subject to an equal rotation it can fail to render in a manner which is slightly dependent on the platform the program is running on. This will typically result in a warning at render, and a rendered piece being removed from the final output.
The solution to this is to always provide a clear overlap for surfaces which are to be removed, such as by adding a small value called an epsilon:
Note that a similar issue occurs with unions, where coincident faces to be merged must also be given an epsilon value to guarantee they are always inside.
There is a second preview-only flickering result which can also occur with faces that are not even supposed to be visible in the final result, for example because they're were negative faces used for removal by a difference operation. This second case impact of fully properly removed faces (or negative faces) is an artifact of the library used for drawing the preview, and will not affect the render. If a clean preview result is desired such as for imaging output, these can be adjusted by an epsilon value in the same manner. See this discussion for other details.
    See also: w:Z-fighting

## Why are some parts (e.g. holes) of the model not rendered correctly?

This can happen when using features like linear_extrude or when importing objects. The convexity of the objects is not known. For more complex objects, the convexity parameter can be used to specify the value. Note that higher values cause a slowdown in preview.
The user manual (section Extrude parameters for all extrusion modes) describes how to calculate the number that should be given to the convexity parameter.
And other workaround might be to use render to forces the generation of a mesh even in preview mode.
    See also: w:Convexity_(mathematics)

## Why does difference (or intersection) sometimes not work in preview?

In perspective mode, the previewer does not process differences or intersections where the camera is inside the invisible object. This is most commonly seen when using a large object to cut away significant parts of the model.
Workarounds:
* Keep the camera outside the invisible objects.
* Keep the invisible objects modest-sized so that it is easier to keep the camera outside them.
* Wrap render around the difference or intersection.
* Use orthogonal mode.

## Why is my model appearing with F5 but not F6?

This can be caused by polyhedrons with flipped faces.
This can be visualized in "Thrown Together" display mode. See misordered faces for details.
If the model imports external STL files, see also import related question. It is confusing that the error only occurs if there is more than one object involved, ie it "works" until you add another item.

## Why is the preview so slow?

http://forum.openscad.org/Why-is-for-so-slow-tp11511p11531.html
This is hard to explain, but in essence, having intersections (or a difference) as the negative objects in difference is expensive. The preview rendering algorithm allows having only primitive objects as negatives, and everything else has to be unpacked.
For example (using A+B = union / A-B = difference / A*B = intersection):
A - B*C - D*E
becomes: A-B-D + A-B-E + A-C-D + A-C-E
..and if A is more complex:
A+B - C*D - E*F
becomes: A-C-E + A-C-F + A-D-E + A-D-F + B-C-E + B-C-F + B-D-E + B-D-F
All combinations have to be rendered, which can take some time, especially on older GPUs, and especially on low-end Intel GPUs.

# Import
## Why is my imported STL file appearing with F5 but not F6?

This is mostly caused by bad STL files, the best bet is to verify the STL file in a tool like Blender, MeshLab or NetFabb and fix the issues. In essence the model needs to be manifold to be processed in OpenSCAD.
The reason for the model still appearing in preview mode is that there is no real geometry calculation going on yet. The preview simply draws the triangles from the STL.
There is one specific issue that causes problems called "Zero faces" (meaning the STL contains triangles with zero area because all 3 points are on one line), which is currently not handled well in OpenSCAD.
Using MeshLab
MeshLab has a filter to remove zero faces by flipping edges of polygons
Filters -> Cleaning and Repairing -> Remove T-Vertices by Edge-Flip.
Set the Ratio to a high value (e.g. 1000000), otherwise it's possible the model gets distorted.
Using Blender
Blender has a 3D-Printing-Toolbox Plug-in (needs to be enabled in the UserSettings) that can show issues with the STL file. See http://wiki.blender.org/index.php/Extensions:2.6/Py/Scripts/Modeling/PrintToolbox
Using NetFabb/Microsoft cloud service
The Microsoft 3D Model Repair service can help with fixing STL files. Make sure to read the service conditions before posting files. See https://modelrepair.azurewebsites.net/

## I'm getting "Unsupported DXF Entity" warnings when importing DXF files. What does that mean?

DXF import sometimes produces warning messages like Unsupported DXF Entity 'SPLINE' (1c1) in "file.dxf". This means the DXF file is using features that the OpenSCAD importer does not know how to handle. The importer simply ignores those unknown entities that could result in an incomplete model.
When using Inkscape, the easiest way to produces DXF files without unsupported entities is to convert all Bezier curves to short line segments using
Extensions -> Modify Path -> Flatten Beziers
The value given in the dialog determines the length of the line segments. Lower values produce smoother results, but also more line segments. As export file format, use "Desktop Cutting Plotter (AutoCAD DXF R14)".
A more detailed tutorial is available at http://repraprip.blogspot.de/2011/05/inkscape-to-openscad-dxf-tutorial.html

# Export
## How can I export multiple parts from one script?

Answer based on comments in related issue on github https://github.com/openscad/openscad/pull/1534#issuecomment-227024209
There is a way to generate a bunch of geometric primitives and export them as STL files from a single script, without commenting/uncommenting code.
The variable PARTNO indicates which part is being exported in the current run. If PARTNO is 'undef', then nothing is exported.
When working interactively, the PARTNO variable at the top of the file can be set to the number of the part to be shown/exported from the GUI.
It's possible to automate the process of exporting all of the parts by writing a shell script on MacOS or Linux, or a batch file on Windows. The shell script would look something like this:
Running this script once from the command line exports all of the parts to separate files.

## How can I export screenshots with higher resolution than the current window

Right now that is not possible from the GUI, as the images are restricted to the actual display context. Using the File->Export->Export As Image menu always exports at viewport resolution.
It is however possible to generate higher resolution images via command line using the --imgsize parameter. This uses a separate drawing context, size-limited by memory and the graphics driver, to generate the image. For example, on Linux, the Mesa driver for Intel UHD Graphics 620 (Kabylake GT2) seems to max out at an image resolution of about 16000×16000.

# Language
## Why am I getting an error when writing a = a + 1?

http://forum.openscad.org/A-A-1-tp11385p11411.html
First of all, the question why we have these "limitations" become more clear once we start better exploiting the opportunities.
* We need a "reduce" function to help collecting information depending on a list of input. Recursion is fine, but people tend to struggle with it and we could offer some help.
* We should probably disallow any attempt of reassignment, to make it more clear what's going on. The only real reason we partially allow it is to allow cmd-line variable overrides.
To help think about things:
* Imagine every expression in OpenCAD being executed in parallel. Any dependency of existing expressions must be made explicit by hierarchical grouping. This should quell the idea of iterating for the purpose of accumulating information.
* In terms of functions: Imagine a function expression being something you'd type into a spreadsheet cell. Not totally mappable, but it might help framing it.
* The spreadsheet analogy applies also to iterations. A cell in a spreadsheet cannot increment itself; attempting to do so results in a circular reference error in the spreadsheet.
Now, we could add all kinds of sugar to help people apply their existing programming problem solving skills. The questions are more if it really helps us, and who would spearhead the design of such language extensions, as we currently don't really have attachment for these ideas on the dev-team.
If you think about the OpenSCAD language as something similar to HTML, but for 3D modeling, you'd still have a need for various programs generating code in this language (similar to the plethora of HTML generators out there). There exist a number of tools for helping with OpenSCAD code generation from existing programming languages (python, ruby, C++, haskell, clojure off the top of my head) and there are tools offering Javascript interfaces for similar purposes (OpenJSCAD, CoffeeSCAD). Until we have a really good reason to do so in OpenSCAD proper, and a really good candidate for which language to support, it's better to keep these things separate.
See also for help: List Comprehension, Tips & Tricks, Recursive Functions

# User Interface
## OpenSCAD isn't adhering to my GTK desktop theme

You may need to install package "qt5-style-plugins" on Debian-based systems and "qt5-qtstyleplugins" on Fedora-based systems, then set environment variable when calling openscad QT_QPA_PLATFORMTHEME=gtk2 openscad
To make the setting permanent, add export QT_QPA_PLATFORMTHEME=gtk2 to your user's ~/.profile

## OpenSCAD GUI is not scaled in Gnome on a 4K / HIDPI Monitor

The GUI Framework Qt used by OpenSCAD seems to need an extra hint to automatically scale correctly for 4K / HIDPI Monitors on Gnome/X11 (e.g. reported on Ubuntu 22.10 with fractional scaling set to 125%).
* Copy openscad.desktop from /usr/share/applications/ to ~/.local/share/applications
* Change Exec=openscad to Exec=env QT_AUTO_SCREEN_SCALE_FACTOR=1 openscad

## I'm not getting any menubar when running OpenSCAD in Ubuntu, how can I get it back?

This seems to be caused by Ubuntu messing with Qt to move the menubar somewhere else (e.g. top of the screen).
That problem hits other applications too, see https://bugs.launchpad.net/ubuntu/+source/appmenu-qt5/+bug/1307619
There are two things that could help:
* Set the QT_QPA_PLATFORMTHEME environment variable to an empty string (the default value is probably "appmenu-qt5") or simply run OpenSCAD with QT_QPA_PLATFORMTHEME= openscad
* Remove the appmenu-qt5 package to globally disable menubar changes for all applications

## Why are the error line numbers wrong?

That is a limitation/bug in the current parser that handles include<> basically as copy&paste of content. In some cases it's possible to work around the issue by placing the include<> statements at the end of the file.
When depending on libraries, it's recommended to use use<> instead which does not have that problem and also automatically inhibits any top-level geometry of that file (which might be there as demo for the library).

## I don't like the editor, can I use my favourite editor instead?

Yes, OpenSCAD supports a special mode that reloads the files if they are modified externally. To enable this mode, check the Design -> Automatic Reload and Preview option and just close the editor window (or use View -> Hide Editor).
See also the section in the user manual: Using an external Editor with OpenSCAD
As an example, here's a script that runs vim as editor and also starts OpenSCAD, which takes the model viewer role.
It supports 3 modes
* Run with no parameters, it opens a temp file for quick testing, which it deletes.
* Run with the name of a non-existent file, it starts the file with a default license header.
* Run with the name of an existing file, it simply opens it.

# Errors / Problems
## Why am I getting "no top level geometry to render"?

This can have different reasons, some common ones include

### Missing / Commented out module call

Using the % modifier does not only make the part transparent, it also causes the part to be excluded in the final render!

### Difference / Intersection with wrong translated objects

The easiest way to solve this type of issues is to highlight the objects using the # modifier and see if the objects are placed at the position where they should be.

### Importing broken STL files

See Why is my imported STL file appearing with F5 but not F6?

## OpenSCAD crashed/was killed, are my unsaved changes lost?

Before starting a preview or render process, the OpenSCAD editor writes a backup file in case there are unsaved changes.
This file is stored in the users documents folder in a separate directory (e.g. on Linux this is normally $HOME/.local/share/OpenSCAD/backups). The actual path can be checked in the Help->Library Info dialog where it is listed as "Backup Path".

## OpenSCAD crashes when clicking "New" or loading a file on Windows

OpenSCAD crashes on some machines with Intel graphics drivers, for more details, see https://github.com/openscad/openscad/issues/2442

## OpenSCAD fails to run refering to EVR.dll, MF.dll or MFPlat.dll on Windows

This is an issue with the special Windows N (Europe) and KN (Korea) versions which have the Windows Media Framework ripped out as a result of a ruling for anti-competitive practices by the European Commission in 2004.
OpenSCAD, starting with release 2019.05, depends on some of the features so it fails to run on those systems.
The missing Windows Media Framework can be added by installing the correct "Media Feature Pack for N versions" from the list Microsoft provides in KB3145500. For Windows 10 version N, there's a dedicated download page with Windows version selector at: https://www.microsoft.com/en-us/software-download/mediafeaturepack.
Starting with Windows 10 1909 you can't download the Media Features from the Microsoft Website directly - instead you have to use Windows Settings > Apps > Apps and Features > Optional Features > Add a Feature and find the Media Feature Pack in the list of available Optional Features. Afterwards reboot and it should work.

# Reporting bugs, Requesting features
## How do I report bugs?

Bugs in OpenSCAD are best reported in the github issue tracking system at https://github.com/openscad/openscad/issues. If you are not sure it's a bug, asking on the mailing list/forum can help clarifying things.
Please try searching through the existing issues if the bug was already reported. If you find something similar or if you are unsure, create a new issue, but mention the (possibly) related one.
The bug report should give as much information as possible to help with reproducing it, including but not limited to
* The OpenSCAD version
* The Operating System name and version
* A description of the scenario that produces the issue
* In case of graphics issues, the OpenGL driver information
* If possible, a trimmed down script reproducing the issue
Most of the technical version information can be found in menu Help -> Library Info, or via the command line openscad --info.

## How do I request new features?

New features or changes/extensions to existing features can be requested in the github issue tracking system at https://github.com/openscad/openscad/issues too.
Please make an effort to clearly explain the new feature / change as detailed as possible. Including some background about why you think this feature would be useful to you and other people helps a lot and increases the chances of it being implemented.

## How do I report bugs that are related to the Operating System I use?
### Windows

The Windows version is currently maintained by the OpenSCAD team, so please use the github issue tracker for reporting bugs.

### Mac OS X

The Mac OS X version is currently maintained by the OpenSCAD team, so please use the github issue tracker for reporting bugs.

### Linux

The OpenSCAD versions included in / distributed by the various Linux distributions are usually maintained by people/teams working with the distributions.
Specific bugs can be reported in the respective bug tracking systems, e.g.
* Debian - See "please report it" directions at https://bugs.debian.org/cgi-bin/pkgreport.cgi?package=openscad
* Ubuntu - See "Report a bug" directions at https://launchpad.net/ubuntu/+source/openscad
* Fedora / Red Hat - See https://apps.fedoraproject.org/packages/openscad/bugs and https://bugzilla.redhat.com/buglist.cgi?component=openscad
* Arch Linux - See "reporting bug guidelines" directions at https://bugs.archlinux.org/index.php?string=openscad&status%5B%5D=
The nightly builds hosted on the openSUSE build service are maintained by the OpenSCAD team, so please use the github issue tracker for reporting issues with those packages.

# Chapter 10 -- Libraries

OpenSCAD User Manual

## Library locations

OpenSCAD uses three library locations, the installation library, built-in library, and user-defined libraries.
* The Installation library location is the libraries directory under the directory where OpenSCAD is installed.
* The Built-In library location is O/S dependent. Since version 2014.03, it can be opened in the system specific file manager using the "File->Show Library Folder..." menu entry.
** Windows: My Documents\OpenSCAD\libraries
** Linux: $HOME/.local/share/OpenSCAD/libraries
** Mac OS X: $HOME/Documents/OpenSCAD/libraries
* The User-Defined library path can be created using the OPENSCADPATH Environment Variable to point to the library(s). OPENSCADPATH can contain multiple directories in case you have library collections in more than one place, separate directories with a semi-colon for Windows, and a colon for Linux/Mac OS. For example:
       Windows: C:\Users\A_user\Documents\OpenSCAD\MyLib;C:\Thingiverse Stuff\OpenSCAD Things;D:\test_stuff
       (Note: For Windows, in versions prior to 2014.02.22 there is a bug preventing multiple directories in OPENSCADPATH as described above, it uses a colon (:) to separate directories. A workaround, if your libraries are on C: is to leave off the drive letter & colon, e.g. \Thingiverse Stuff\OpenSCAD Things:\stuff. For more about setting Windows environment variables, see User Environment Variables.
       Linux/Mac OS: /usr/lib:/home/mylib:.
       OpenSCAD must be restarted to recognize any change to the OPENSCADPATH Environment Variable.
When you specify a non-fully qualified path and filename in the use <...> or include <...> statement OpenSCAD looks for the file in the following directories in the following order:
* the directory of the calling .scad file
* the User-Defined library paths (OPENSCADPATH)
* the Built-In library (i.e. the O/S dependent locations above)
* the Installation library
In the case of a library file itself having use <...> or include <...> the directory of the library .scad file is the 'calling' file, i.e. when looking for libraries within a library, it does not check the directory of the top level .scad file.
For example, with the following locations and files defined: (with OPENSCADPATH=/usr/lib:/home/lib_os:.)
The following include <...> statements match to the nominated library files
Since 2014.03, the currently active list of locations can be verified in the "Help->Library Info" dialog.
The details info shows both the content of the OPENSCADPATH variable and the list of all library locations. The locations are searched in the order they appear in this list. For example;

### Setting OPENSCADPATH

In Windows, Environment Variables are set via the Control panel, select System, then Advanced System Settings, click Environment Variables. Create a new User Variable, or edit OPENSCADPATH if it exists.
On Linux, to simply add the environment variable to all users, you can type in terminal:
sudo sh -c 'echo "OPENSCADPATH=$HOME/openscad/libraries" >>/etc/profile'
to set the OPENSCADPATH to openscad/libraries under each user's home directory. For more control on environment variables, you'll need to edit the configuration files; see for example this page.
On macOS, you can use launchctl to set the environment variable for the current logged in user:
launchctl setenv OPENSCADPATH "/Users/myuser/my/own/path"
The variable will be available the next time you launch OpenSCAD.

## MCAD

OpenSCAD bundles the MCAD library.
There are many different forks floating around (e.g., , ) many of them unmaintained.
MCAD bundles a lot of stuff, of varying quality, including:
* Many common shapes like rounded boxes, regular polygons and polyhedra in 2D and 3D
* Gear generator for involute gears and bevel gears.
* Stepper motor mount helpers, stepper and servo outlines
* Nuts, bolts and bearings
* Screws and augers
* Material definitions for common materials
* Mathematical constants, curves
* Teardrop holes and polyholes
The git repo also contains python code to scrape OpenSCAD code, a testing framework and SolidPython, an external python library for solid cad.
More details on using MCAD are in a later chapter, OpenSCAD User Manual/MCAD.

## Other libraries

* Belfry OpenScad Library has many shapes, masks, manipulators, and support for threading, gears, polylines and beziers.
* Bevel library for OpenScad
* BOLTS tries to build a standard part and vitamin library that can be used with OpenSCAD and other CAD tools.
* Celtic knot library is used for the generation of celtic knots.
* Colorspace converter for working with colors in HSV and RGB:
* Dimensioned Drawings provides tools to create proper 2D technical drawings of your 3D objects.
* DotSCAD comprehensive library of 2D and 3D operations and transforms including extrusion along arbitrary paths, shape bending, etc.
* Fillets, a comprehensive fillets library by Stephanie Shaltes.
* Local.scad provides a flexible method for positioning parts of a design. Is also used in BOLTS.
* Michigan Tech's Open Sustainability Technology Lab (MOST) libraries
* Obiscad contains various useful tools, notably a framework for attaching modules on other modules in a simple and modular way.
* OpenSCAD threads library: provides ISO conform metric and imperial threads and support internal and external threads and multiple starts.
* Pinball Library: provides many components for pinball design work, including models for 3d printing of the parts, 3d descriptions of mount holes for CNC drilling and 2d descriptions of parts footprint
* Regular shapes library by Giles Bathgates]: provides regular polygons and polyeders and is included in MCAD.
* Roller Chain Sprockets OpenSCAD Module lets you create sprockets for ANSI chains and motorcycle chains. Contains hard coded fudge factors, may require tweaking.
* SCADBoard is a library for designing 3D printed PCBs in OpenSCAD.
* Shapes library contains many shapes like rounded boxes, regular polygons. It is also included in MCAD.
* The 2D connection library helps with connections between 2D sheets, which is useful for laser cut designs.
* Ruler helps in determining the size of things in OpenSCAD.
* Knurled surface library by aubenc
* Text module based on technical lettering style.
* Round corners for Openscad, also at https://www.thingiverse.com/thing:8812
* Unit test framework
* Utility function collection.
* Workflow library: full workflows, by Ulrich Bär
There is also a list with more libraries here: https://github.com/openscad/openscad/wiki/Libraries

## Other OpenSCAD tutorials and documentation

* "OpenSCAD User Manual" http://www.openscad.org/documentation.html
* "Know only 10 things to be dangerous in OpenSCAD" https://cubehero.com/2013/11/19/know-only-10-things-to-be-dangerous-in-openscad/
* "OpenScad beginners tutorial" http://edutechwiki.unige.ch/en/OpenScad_beginners_tutorial
* "How to use Openscad, tricks and tips to design a parametric 3D object" http://www.tridimake.com/2014/09/how-to-use-openscad-tricks-and-tips-to.html
* OpenSCAD discussion forum http://forum.openscad.org

# Chapter 11 -- Command Glossary

OpenSCAD User Manual
This is a Quick Reference; a short summary of all the commands without examples, just the basic syntax. The headings are links to the full chapters.
Please be warned: The Command Glossary is presently outdated (03 2015).
Please have a look at the Cheatsheet, instead:
http://www.openscad.org/cheatsheet/

## Modules

Variables can be default initialized <var1>=<defaultvalue>
In module you can use children to refer to all child nodes, or children(i) where i is between 0 and $children.

## Include Statement

After 2010.02
filename could use directory (with / char separator).
Prior to 2010.02

## Other Language Features

When $fa and $fs are used to determine the number of fragments for a circle, then OpenSCAD never uses less than 5 fragments.
The $t variable is used for animation. If you enable the animation frame with view->animate and give a value for "FPS" and "Steps", the "Time" field shows the current value of $t.