Development howto

OpenSCAD Development HOWTO

This document is meant to help new developers get started, as well as provide documentation/checklists for typical development tasks

Development Environment

The documentation has some info on this

Mac OS X

Linux

Windows

Building binaries for development

Test Framework

See testing.txt

Contributing

Licensing

Adding new features

• Write code. If related to a github issue, mention this in commit messages (e.g. "related to #")
• Add or modify test cases
• For new modules or larger changes: Add an example
• Verify that all tests pass. Remember to run all tests (ctest -C All)
• Update documentation (wikibooks)
• Update RELEASE_NOTES
• Update cheatsheet

References

File Formats

STL

StereoLithography file format.

Status

Import: Supported

Export: Supported

Links

• Format: http://www.ennex.com/~fabbers/stl.asp
• Wikipedia: https://en.wikipedia.org/wiki/STL_%28file_format%29

AMF

ASTM Additive Manufacturing File Format (AMF) - developed by ASTM Committee F42 on Additive Manufacturing Technologies.

Status

Import: WIP - https://github.com/openscad/openscad/pull/836

Export: Supported (single volume only)

Links

• Homepage: http://stl2.org/ (http://amf.wikispaces.com/)
• Tutorial
  • Part 1: http://online.liebertpub.com/doi/pdf/10.1089/3dp.2014.1500
• Wikipedia: https://en.wikipedia.org/wiki/Additive_Manufacturing_File_Format

glTF

glTF is the runtime asset format for WebGL, OpenGL ES, and OpenGL. This is quite new and not finalized but interestingly supported by LibreOffice 4.3, so it might be interesting to support that as export format - This is also supposed to support animation, maybe even OpenSCAD animations could be exported?

Status

Import: Not supported

Export: Not supported

Links

• Homepage: http://gltf.gl/
• Specification: https://github.com/KhronosGroup/glTF