Skip to content

README.md

Latest commit

 

History

History
32 lines (28 loc) · 1.47 KB

README.md

File metadata and controls

32 lines (28 loc) · 1.47 KB

Cadifier

This is a CAD runtime supporting Replicad and OpenScad script files targeting web browser. Main focus is on having support for multi file Replicad projects with TypeScript.

Note: This is still a work in progress / beta versions and has a lot of issues.

Features

  • Specify CAD model by using Replicad or OpenScad.
  • Use model parts inside assemblies.
  • On configuration change re-renders only the changed files of the model.
  • Automatic BOM generation.
  • 2D printable templates from the models spanning multiple pages.
  • Fully local build and rendering when viewing online.
  • TypeScript syntax support (no npm dependencies)
  • Widgets for intuitive model modification

Development

The code is written in Kotlin and is targeting KotlinJS and JVM for CLI and bundle parsing.

Module Structure

  • cadifier-api - TypeScript bindings for runtime
  • cadifier - Bundle parsing, local server and CLI interface
  • data - Data model for Bundle and utility methods
  • instructions - Documentation / Instructions for project usage
  • runtime - Bundle processing, change detection, web-worker orchestration
  • runtime-openscad-worker - OpenScad Web Assembly worker
  • runtime-replicad-worker - Replicad web worker handling parts and assemblies
  • test-utils - Helper for creating bundles in testing
  • threejs_kt - Kotlin Three.JS definitions
  • viewer - UI and 3d viewer
  • viewer-web - Additional set up when deploying to web
  • web - Homepage and examples