# jscad-desktop > jscad desktop application Latest version **0.2.0** (published 2018-04-04) · MIT license · 0 weekly downloads ## Install ```sh npm install jscad-desktop pnpm add jscad-desktop yarn add jscad-desktop bun add jscad-desktop ``` ## Health **Score 5/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support; pre 1.0. Negative: insecure dependencies; abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 0.2.0 | | Published | 2018-04-04 | | First published | 2018-04-04 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 29 | | Unpacked size | 1.5 MB | | Known vulnerabilities | 0 | | Install scripts | no | | Author | jscad core team/ Mark Moissette | | Maintainers | kaosat-dev | ## Links - npm: https://www.npmjs.com/package/jscad-desktop - npm.io page: https://npm.io/package/jscad-desktop ## Dependencies (29) - [bel](https://npm.io/package/bel.md) ^5.1.5 - [most](https://npm.io/package/most.md) ^1.7.2 - [astring](https://npm.io/package/astring.md) ^1.2.0 - [decache](https://npm.io/package/decache.md) ^4.3.0 - [esprima](https://npm.io/package/esprima.md) ^4.0.0 - [ast-eval](https://npm.io/package/ast-eval.md) ^0.8.0 - [morphdom](https://npm.io/package/morphdom.md) ^2.3.3 - [nanomorph](https://npm.io/package/nanomorph.md) ^5.1.3 - [strip-bom](https://npm.io/package/strip-bom.md) ^3.0.0 - [@jscad/csg](https://npm.io/package/@jscad/csg.md) 0.5.3 - [estraverse](https://npm.io/package/estraverse.md) ^4.2.0 - [most-proxy](https://npm.io/package/most-proxy.md) ^3.3.0 - [@jscad/core](https://npm.io/package/@jscad/core.md) 0.2.0 - [ast-parents](https://npm.io/package/ast-parents.md) 0.0.1 - [static-eval](https://npm.io/package/static-eval.md) ^2.0.0 - [@most/create](https://npm.io/package/@most/create.md) ^2.0.1 - [detective-cjs](https://npm.io/package/detective-cjs.md) ^2.0.0 - [blob-to-buffer](https://npm.io/package/blob-to-buffer.md) ^1.2.6 - [electron-store](https://npm.io/package/electron-store.md) ^1.3.0 - [@jscad/io-utils](https://npm.io/package/@jscad/io-utils.md) 0.1.2 - [@jscad/csg-viewer](https://npm.io/package/@jscad/csg-viewer.md) github:jscad/csg-viewer - [esprima-ast-utils](https://npm.io/package/esprima-ast-utils.md) 0.0.7 - [@jscad/amf-serializer](https://npm.io/package/@jscad/amf-serializer.md) 0.1.1 - [@jscad/dxf-serializer](https://npm.io/package/@jscad/dxf-serializer.md) 0.1.2 - [@jscad/stl-serializer](https://npm.io/package/@jscad/stl-serializer.md) 0.1.1 - [@jscad/svg-serializer](https://npm.io/package/@jscad/svg-serializer.md) 0.1.1 - [@jscad/x3d-serializer](https://npm.io/package/@jscad/x3d-serializer.md) 0.1.1 - [jscad-tree-experiment](https://npm.io/package/jscad-tree-experiment.md) github:kaosat-dev/jscad-tree-experiments - [@jscad/json-serializer](https://npm.io/package/@jscad/json-serializer.md) 0.1.1 ## Recent versions - 0.2.0 (latest) — 2018-04-04 ## README # jscad-desktop [![GitHub version](https://badge.fury.io/gh/jscad%2Fdesktop.svg)](https://badge.fury.io/gh/jscad%2Fdesktop) [![Build Status](https://travis-ci.org/jscad/desktop.svg)](https://travis-ci.org/jscad/desktop) ![light ui](./docs/jscad-desktop-light.jpg) ![dark ui](./docs/jscad-desktop-dark.jpg) > Experimental desktop jscad (openjscad) client, built using Electron A LOT OF THE THINGS HERE CAN AND WILL CHANGE!! This softare is pre-alpha, use at your own risk etc ! ## Overview - this app works pretty much like the web based OpenJSCAD.org (but does not included a text editor, see below) - it automatically saves & reloads most settings and the last design you were working on on restart - there is basic theming support (only two are present, you can change them but not add more at this time) - uses the shiny new 3D viewer based on regl - uses most.js observables & a declarative approach internally ### what is supported: * almost all of the features of OpenJSCAD EXCEPT the things in the paragraph below ### what is not supported - the include() function , [since include is EVIIIL and an antipattern (an alternative to include() will soon be provided)](https://github.com/jscad/OpenJSCAD.org/issues/245) - direct loading/conversion of other formats expect for .js/jscad is not supported (yet) - there is no text editor included, because I am still on the fence about including one: why have something half baked when there are so many great , free & open source code editors these days ? ([Atom](https://atom.io/), [Visual Studio Code](https://code.visualstudio.com/)) - transitive file watching is not yes supported: ie if you change things outside of your main file, the ui will not update - file watching can fire change events twice occasionaly ### script handling * you can either select a file (jscad or js) or folder from the load jscad menu or drag & drop a file or folder * the lookup in folders is done as follows : - if there is a package.json file, the file specified in the 'main' field is used (standard node.js) - if there is no package.json the program tried to look for either an index.js/jscad file or a main.js/jscad file - if that fails it tries to look for a js/jscad file that has the same name as the folder * unlike the web based UI you can (and are **encouraged to**) use jscad designs defined as common.js modules, so you can use ```require()``` calls to include other functions, shapes etc * in your main file, when using common.js modules please use named exports ie : ```javascript module.exports = {main, getParameterDefinitions}``` * VERY IMPORTANT : if you use common.js modules you HAVE to `require()` all the OpenJSCAD modules you use (like `@jscad/csg` etc) **yourself**: if the app detects that you do not have `module.exports`, then it will inject all the OpenJSCAD api itself, with a MAJOR limitation at this time: you cannot make require() calls from anything but the root level file, and you do not have access to the API (this will get fixed) > there will NOT be out of the box support for es6 modules anytime soon, please use a transpiler (Babel.js etc) if you want to use es modules ## geometry caching this is an experimental feature that adds a HUGE performance boost by turning the various geometry creation functions (so cube(), sphere(), union(), difference() etc into a virtual tree, and caching each of the items in the tree when evaluating the tree into actual csg/cag object you can see more information about it [here](https://github.com/kaosat-dev/jscad-tree-experiments) >Tip: to take even more advantage of this feature, please have your *main()* script return an array of shapes if there are multiple independant shapes/parts, as union() operations are more costly This desktop app also saves your current design's cache to the hard drive, making a reload after restarting the app very fast! IF you follow the instructions/limitations below ### Limitations - LIMITATION 1 : this **ONLY WORKS WITH THE FUNCTIONAL API** !! ie cube(), sphere(), union(), difference(), translate(), scale() etc but **NOT** CSG.cube(), csgObject.union(xxx), csgObject.translate(xxx) - LIMITATION 2: because of the limitation above you CANNOT mix the two coding styles: so this is **FUNCTIONAL API ONLY, NO MIXING** !! since the non functional api will become deprecated soon, this is future facing decision regardless :) ### How to use it : (temporary instructions) > Note: this is experimental, and somewhat clunky, will VERY LIKELY change in the future !!! 1 - with explicit require() calls (prefered method) - toggle the 'Experimental geometry caching:' setting in the options panel (turned on by default) - install the following package in your design ```npm install kaosat-dev/jscad-tree-experiments``` - replace your ```require('@jscad/csg/api')``` calls with ```require('jscad-tree-experiment').api``` - example : this script ```javascript const {cylinder} = require('@jscad/csg/api').primitives3d const {color} = require('@jscad/csg/api').color const {difference} = require('@jscad/csg/api').booleanOps const {translate} = require('@jscad/csg/api').transformations module.exports = function assemblyMount (params) { const {plateThickness, plateOffset, assemblyMountDia, assemblyMountBoltDia} = params return translate([0, 0, plateThickness], color('gray', difference( cylinder({h: plateOffset - plateThickness, d: assemblyMountDia}), cylinder({h: plateOffset - plateThickness, d: assemblyMountBoltDia}) ) )) } ``` should become ```javascript const {cylinder} = require('jscad-tree-experiment').api.primitives3d const {color} = require('jscad-tree-experiment').api.color const {difference} = require('jscad-tree-experiment').api.booleanOps const {translate} = require('jscad-tree-experiment').api.transformations module.exports = function assemblyMount (params) { const {plateThickness, plateOffset, assemblyMountDia, assemblyMountBoltDia} = params return translate([0, 0, plateThickness], color('gray', difference( cylinder({h: plateOffset - plateThickness, d: assemblyMountDia}), cylinder({h: plateOffset - plateThickness, d: assemblyMountBoltDia}) ) )) } ``` you can find an example design that uses these imports and makes full use of the speedups here: https://github.com/kaosat-dev/Isolos 2 - For old still scripts without explicit require() calls just toggle the 'Experimental geometry caching:' setting in the options panel (turned on by default) be warned however that a lot of the official examples etc will not work with this out of the box pre-alpha, expect bugs! ## Table of Contents - [Installation](#installation) - [Usage](#usage) ## Installation ``` git clone this repository cd jscad-desktop npm i ``` ## Usage For now , dev mode only! to start the app, in the root folder , type ``` npm run dev ``` - drag & drop a jscad/js file to get started - left/right drag to rotate camera - shift + drag to pan - double click to reset camera & controls - tripple click to zoomToFit on the items in the scene - there are also keyboard shortcuts for camera angles and orthographic/perspective you can take a look at them & change them in the data/keybindings.json file (requires restart)   * `t` : top view * `b` : bottom view * `l` : left view * `r` : right view * `f`: front view * `b`: back view (yes 'b' is bound to both bottom & back views, whoops) * warning ! panning is broken in orthographic mode * `p`: perspective projection * `o`: orthographic projection - most of the ui options should be explicit ## License [The MIT License (MIT)](./LICENSE) (unless specified otherwise) --- _Source: https://npm.io/package/jscad-desktop · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._