OpenJsCad.org is a more up-to-date OpenJsCAD frontend where you can edit .jscad files either locally or online via JS editor (built-in). A few functions are available to make the transition from OpenSCAD to OpenJSCAD easier (scad-api built-in), as well CLI (command-line interface) for server-side computations with NodeJS.
Go to OpenJSCAD.org (Tested browsers include Chrome, Firefox, Opera, Safari)
cd base-directory-of-website
git clone https://github.com/jscad/OpenJSCAD.org
cd OpenJSCAD.org
<start a web server here>
And then access the contents via the URL of the web-site.
- index.html for the standard version
- viewer-minimal.html for the barebones viewer
- viewer-options.html for the 'all options' variant of the above
NOTE: You might need configuration changes to allow access to the some of the contents (examples etc).
For CLI(command-line interface) use
npm install -g @jscad/openjscad
Note: you need a recent , LTS version of Node.js > 6.x.x An easy way to install any Node.js version is to use NVM
you can now turn the examples (or your own designs) into stl etc files as follows :
% cd examples/
% openjscad example005.jscad # -- creates example005.stl as default
% openjscad example001.jscad -o test.stl
% openjscad example001.scad -o example001scad.jscad # -- convert .scad into .jscad
% openjscad frog.stl -o test.jscad # -- convert .stl into .jscad
% openjscad logo.jscad -of amf # -- convert logo.jscad into logo.amf
Note: you need a recent , LTS version of Node.js > 6.x.x, see here for more details)
npm install --save @jscad/openjscad
and then simply import and use openjscad:
const jscad = require('@jscad/openjscad')
const fs = require('fs')
var script = `function main() {
return [
torus()
]
}`
// generate compiled version
var params = {}
var compiled = jscad.compile(script, params)
// generate final output data, choosing your prefered format
var outputData = jscad.generateOutput('stlb', compiled)
// hurray ,we can now write an stl file from our OpenJsCad script!
fs.writeFileSync('torus.stl', outputData.asBuffer())you can also use the 'generateOutput' function directly with CSG/CAG objects ie :
const csg = require('csg').CSG
const input = csg.cube([1, 1, 1]) // one of many ways to create a CSG object
const outputData = jscad.generateOutput('stlb', input)
// hurray ,we can now write an stl file from our raw CSG objects
fs.writeFileSync('torus.stl', outputData.asBuffer())compile(params, source)
compile OpenJsCad code and generates CSG representation this returns a promise that gets resolved with the CSG object.
(the ordering of parameters was created with currying in mind)
params the set of parameters to use source the OpenJsCad script we want to compile
generateOutput(outputFormat, csgs)
generate output data from a CSG/CAG object or array of CSG/CAG objects
outputFormat the output file format csgs the CSG/CAG object or array of CSG/CAG objects
Note: for now you need to use outputData.asBuffer() to get a Node.js buffer for writing to disk etc
From version 1.0.0 onwards, almost all the individual parts of this project are available directly as scoped NPM modules , and can be used independently from this repo. The full list of these is available here: https://www.npmjs.com/org/jscad
One example of what can be achieved with this can be found here This means you can :
- easily create your own renderer for the CSG/Cag data structures
- create custom UIs
- use the different parts in Node.js or the Browser
- cherry pick what formats you want to use for input/output without needing the dependencies of all packages
- lots more !
This will be expanded upon in the future, and is the backbone of the newer, modular Jscad
OpenJSCAD.org is part of the JSCAD Organization, and is maintained by a group of volunteers. We welcome and encourage anyone to pitch in but please take a moment to read the following guidelines.
-
If you want to submit a bug report please make sure to follow the Reporting Issues guide. Bug reports are accepted as Issues via GitHub.
-
If you want to submit a change or a patch, please see the Contributing guidelines. New contributions are accepted as Pull Requests via GithHub.
-
We only accept bug reports and pull requests on GitHub.
-
If you have a question about how to use the OpenJSCAD.org, then please start a conversation at the OpenJSCAD.org User Group. You might find the answer in the OpenJSCAD.org User Guide.
-
If you have a change or new feature in mind, please start a conversation with the Core Developers and start contributing changes.
Small Note: If editing this README, please conform to the standard-readme specification.
See for more details
- G+ OpenJSCAD.org Announcements
- G+ OpenJSCAD Community to discuss with other user and developers.
OpenJSCAD and its sub components are built upon great open source work, contribution & modules
- csg.js core & improvements by Evan Wallace, Eduard Bespalov, Joost Nieuwenhuijse, Alexandre Girard
For input/output
Tooling:
and many more!
The MIT License (MIT) (unless specified otherwise)
Simple JSCAD example (logo.jscad) try it:
More sophisticated JSCAD example, with functions dedicated to object generation and with interactive parameters (gear.jscad) try it :
Import of STL models (frog-OwenCollins.stl) try it:
Drag & drop a local file:
Drag & drop multiple files (Chrome & Firefox) or a folder (Chrome):
- OpenJsCAD, starting point of OpenJSCAD.org
- OpenSCAD.net, another place of inspiration, where the OpenSCAD translator was adapted from
- CoffeeSCad, JavaScript simplified (no more {}) (defunct)
- stl2pov to convert .stl to .pov, and then render via PovRay.org
- P3D STL/AMF/OBJ viewer
That's all for now,
Rene K. Mueller, Jeff Gay, Mark Moissette & JSCAD Organization