[{"_1":2,"_179":-5,"_180":-5},"loaderData",{"_3":4,"_17":18,"_25":26,"_158":159},"root",{"_5":-5,"_6":-7,"_7":8,"_9":-7,"_10":11,"_12":-7,"_13":14,"_15":16},"currentUser","primaryEmail","siteVerification","6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI","toast","enableDev",false,"incidentStatus","theme","system","contrast","normal","routes/_layout",{"_19":-5,"_20":21,"_22":21,"_23":11,"_24":21},"username","isAskGordonEnabled",true,"isUsingNewTemplate","showMinimalLanding","showHoneypotTrap","routes/_layout.r.$namespace.$reponame",{"_27":28,"_29":-5,"_30":11,"_31":11,"_32":33,"_34":35,"_36":-5,"_37":11,"_38":39,"_88":89,"_109":110,"_147":-5,"_148":11,"_149":21,"_150":11,"_151":-5,"_152":11,"_153":-5,"_154":155,"_156":111,"_157":-7},"canonicalUrl","https://hub.docker.com/r/devrt/openjscad/tags","mcpServer","canSeeDockerfile","canSeeAutobuilds","namespace","devrt","reponame","openjscad","cloudBuildSource","isAutobuildsAvailable","repo",{"_40":41,"_42":43,"_45":46,"_47":48,"_49":11,"_50":51,"_52":53,"_54":55,"_57":35,"_32":33,"_58":59,"_60":44,"_61":62,"_63":64,"_65":66,"_67":-5,"_68":62,"_69":70,"_71":11,"_72":33,"_73":74,"_79":21,"_80":81,"_85":33,"_86":87},"categories",[],"content_types",[44],"image","date_registered","2017-09-02T00:56:41.787556Z","description","OpenJSCAD.org","is_private","last_updated","2018-03-29T06:14:38.494164Z","last_modified","2024-10-16T13:48:34.145251Z","media_types",[56],"application/vnd.docker.container.image.v1+json","name","pull_count",1942,"repository_type","star_count",0,"status",1,"status_description","active","source","collaborator_count","full_description","# OpenJSCAD.org\n

\n\n>*OpenJsCad.org* is a more up-to-date [OpenJsCAD](http://joostn.github.com/OpenJsCad/) frontend where you can edit .jscad files either locally or online via JS editor (built-in).\nA few functions are available to make the transition from [OpenSCAD](http://openscad.org/) to OpenJSCAD easier ([scad-api](https://github.com/jscad/scad-api) built-in),\nas well CLI (command-line interface) for server-side computations with NodeJS.\n\n[![Backers on Open Collective](https://opencollective.com/openjscad/backers/badge.svg)](#backers) [![Sponsors on Open Collective](https://opencollective.com/openjscad/sponsors/badge.svg)](#sponsors) [![GitHub version](https://badge.fury.io/gh/jscad%2FOpenJSCAD.org.svg)](https://badge.fury.io/gh/jscad%2FOpenJSCAD.org)\n[![Build Status](https://travis-ci.org/jscad/OpenJSCAD.org.svg?branch=master)](https://travis-ci.org/jscad/OpenJSCAD.org)\n[![Dependency Status](https://david-dm.org/jscad/OpenJSCAD.org.svg)](https://david-dm.org/jscad/OpenJSCAD.org)\n[![devDependency Status](https://david-dm.org/jscad/OpenJSCAD.org/dev-status.svg)](https://david-dm.org/jscad/OpenJSCAD.org#info=devDependencies)\n[![stable](http://badges.github.io/stability-badges/dist/stable.svg)](http://github.com/badges/stability-badges)\n[![](https://images.microbadger.com/badges/image/devrt/openjscad.svg)](https://microbadger.com/images/devrt/openjscad)\n\n## Table of Contents\n\n- [Usage](#usage)\n- [Development](#development)\n- [Documentation](#documentation)\n- [Known issues](#known-issues)\n- [Contribute](#contribute)\n- [Community](#community)\n- [Acknowledgements](#acknowledgements)\n- [License](#license)\n- [Screenshots](#screenshots)\n- [See also](#see-also)\n\n## Usage\n\n### Immediate Use (no installation)\n\nGo to *[OpenJSCAD.org](http://openjscad.org)* (Tested browsers include Chrome, Firefox, Opera, Safari)\n\n### Use within a Web Site (pre built files)\n\n```\ncd base-directory-of-website\ngit clone https://github.com/jscad/OpenJSCAD.org\ncd OpenJSCAD.org\n\n```\nAnd then access the contents via the URL of the web-site.\n * index.html for the standard version\n * viewer-minimal.html for the barebones viewer\n * viewer-options.html for the 'all options' variant of the above\n\n>NOTE: You might need configuration changes to allow access to the some of the contents (examples etc).\n\n#### Use of proxies for remote file loading:\n\nif you want the capability , just like the official OpenJSCAD.org site, to load remote projects/files directly\nfrom the web based user interface, but without the hassle with CORS issues,\nyou can use a proxy file (see [remote.pl](./remote.pl) & [remote.php](./remote.php)):\nthis is a server side script that does the following\n- caches the remote file locally on the server\n- returns the local path to the downloaded file for OpenJSCAD to use\n\nuse and path of the proxy can be set by:\n- changing the `proxyUrl` value in [src/ui/index.js](src/ui/index.js)\n- since this is hardcoded , if you do not use the provided dev server,\n rebuild your main file (npm run build-web etc, see [Development](#development))\n\n\nthen you can use it like so:\nhttps:///?uri=http://www.thingiverse.com/download:164128\nor\nhttps:///#http://www.thingiverse.com/download:164128\n\n>Note: a PR with a node.js based proxy would be a welcome addition :)\n\n\n### Use as Command Line Interface (CLI)\n\n### Install node.js\n\n> IMPORTANT: you need a recent , LTS version of [Node.js](http://nodejs.org/) > 6.x.x\n> we test OpenJSCAD on node.js version **6.x.x** & **7.x.x** all other versions are not guaranteed to work !\n\nAn easy way to install any Node.js version is to use [NVM](https://github.com/creationix/nvm)\n- after installing nvm type ```nvm install v6``` (recomended)\n- then ```nvm use v6```\n\n#### Install OpenJSCAD CLI:\n\nCLI(command-line interface) use\n\n```\n npm install -g @jscad/openjscad\n```\n\nyou can now turn the examples (or your own designs) into stl etc files as follows :\n```\n% cd examples/\n% openjscad example005.jscad # -- creates example005.stl as default\n% openjscad example001.jscad -o test.stl\n% openjscad example001.scad -o example001scad.jscad # -- convert .scad into .jscad\n% openjscad frog.stl -o test.jscad # -- convert .stl into .jscad\n% openjscad logo.jscad -of amf # -- convert logo.jscad into logo.amf\n```\n\n### Use with Node Modules\n\n> Note: you need a recent , LTS version of Node.js > 6.x.x,\n[see here for more details](https://github.com/nodejs/LTS))\nall the same installation & version recomendation as for the use as command-line also apply\n\n```\nnpm install --save @jscad/openjscad\n```\n\nand then simply import and use openjscad:\n\n```javascript\nconst jscad = require('@jscad/openjscad')\nconst fs = require('fs')\n\nvar script = `function main() {\n return [\n torus()\n ]\n}`\n\n// generate compiled version\nvar params = {}\njscad.compile(script, params).then(function(compiled) {\n // generate final output data, choosing your prefered format\n var outputData = jscad.generateOutput('stlb', compiled)\n // hurray ,we can now write an stl file from our OpenJsCad script!\n fs.writeFileSync('torus.stl', outputData.asBuffer())\n})\n\n```\n\nyou can also use the 'generateOutput' function directly with CSG/CAG objects ie :\n\n```javascript\nconst csg = require('csg').CSG\nconst input = csg.cube([1, 1, 1]) // one of many ways to create a CSG object\n\nconst outputData = jscad.generateOutput('stlb', input)\n\n// hurray ,we can now write an stl file from our raw CSG objects\nfs.writeFileSync('torus.stl', outputData.asBuffer())\n```\n\n#### Module api\n\n**compile(params, source)**\n\n compile OpenJsCad code and generates CSG representation\n this returns a promise that gets resolved with the CSG object.\n\n (the ordering of parameters was created with currying in mind)\n\n *params* the set of parameters to use\n *source* the OpenJsCad script we want to compile\n\n\n**generateOutput(outputFormat, csgs)**\n\ngenerate output data from a CSG/CAG object or array of CSG/CAG objects\n\n *outputFormat* the output file format\n *csgs* the CSG/CAG object or array of CSG/CAG objects\n\n>Note: for now you need to use outputData.asBuffer() to get a Node.js buffer for\nwriting to disk etc\n\n\n### Use of the different modular components directly\n\nFrom version 1.0.0 onwards, almost all the individual parts of this project are available\ndirectly as scoped NPM modules , and can be used independently from this repo.\nThe full list of these is available here: https://www.npmjs.com/org/jscad\n\nOne example of what can be achieved with this can be found [here](https://esnextb.in/?gist=0a2ac2c4e189e27692ea964956a3a2e5)\nThis means you can :\n- easily create your own renderer for the CSG/Cag data structures\n- create custom UIs\n- use the different parts in Node.js or the Browser\n- cherry pick what formats you want to use for input/output without needing the\ndependencies of **all** packages\n- lots more !\n\nThis will be expanded upon in the future, and is the backbone of the newer, modular Jscad\n\n\n## Development\n\nWe offer pre-built versions of OpenJSCAD to be uses directly here :\n- [standard](./dist/index.js)\n- [minimalist](./dist/min.js)\n- [with options](./dist/options.js)\n\nbut you can also rebuild them manually if you need :\n\n- standard: ```npm run build-web```\n- minimalist: ```npm run build-min```\n- with options: ```npm run build-opt```\n\n\n### Adding new features in CSG.js or other modules:\nSince OpenJSCAD is made up of multiple dependent modules (csg.js, openscad-openjscad-translator etc),\nthe easiest method is to use ```npm link``` to have a 'live' updating development version of OpenJSCAD:\n\nFor example for CSG.js\n- create a base directory\n- clone this repository ```git clone git@github.com:jscad/OpenJSCAD.org.git```\n- go into OpenJSCAD.org folder ```cd OpenJSCAD.org```\n- install dependencies ```npm install```\n- start dev server : ```npm run start-dev```\n- go back to base directory ```cd ..```\n- clone CSG.js ```git clone git@github.com:jscad/csg.js.git```\n- go into OpenJSCAD.org folder again ```cd OpenJSCAD.org```\n- now type ```npm link ../csg.js/ @jscad/csg```\n\nYou can now make changes to the CSG.js code and see it impact your locally running\ncopy of OpenJSCAD live.\n\n## Documentation\n\n- [OpenJSCAD User & Programming Guide](https://en.wikibooks.org/wiki/OpenJSCAD_User_Guide)\n- [OpenJSCAD Quick Reference](https://en.wikibooks.org/wiki/OpenJSCAD_Quick_Reference)\n\n## Known Issues\n\nThere are a few known issues, please be sure to check this out before submitting additional bug reports/issues.\n\n- Q: issues running certain npm commands like ```npm run build-web``` with [cnpm](https://github.com/cnpm/cnpm)\n- A: this is a [know issue in cnpm](https://github.com/cnpm/cnpm/issues/214) , see [issue #283](https://github.com/jscad/OpenJSCAD.org/issues/283) for more information\n\n## Contribute\n\nOpenJSCAD.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.\n\nThank you to all the people who have already contributed to this project:\n

\n\n* If you want to submit a bug report please make sure to follow the [Reporting Issues](https://github.com/jscad/OpenJSCAD.org/wiki/Reporting-Issues) guide. Bug reports are accepted as [Issues](https://github.com/jscad/OpenJSCAD.org/issues/) via GitHub.\n\n* If you want to submit a change or a patch, please see the [Contributing guidelines](https://github.com/jscad/OpenJSCAD.org/blob/master/CONTRIBUTING.md). New contributions are accepted as [Pull Requests](https://github.com/jscad/OpenJSCAD.org/pulls/) via GithHub.\n\n* We only accept bug reports and pull requests on **GitHub**.\n\n* If you have a question about how to use the OpenJSCAD.org, then please start a conversation at the [OpenJSCAD.org User Group](https://plus.google.com/communities/114958480887231067224). You might find the answer in the [OpenJSCAD.org User Guide](https://github.com/Spiritdude/OpenJSCAD.org/wiki/User-Guide).\n\n* If you have a change or new feature in mind, please start a conversation with the [Core Developers](https://plus.google.com/communities/114958480887231067224) and start contributing changes.\n\nSmall Note: If editing this README, please conform to the [standard-readme](https://github.com/RichardLitt/standard-readme) specification.\n\n## Community\n\nSee for more details\n* [G+ OpenJSCAD.org Announcements](https://plus.google.com/115007999023701819645)\n* [G+ OpenJSCAD Community](https://plus.google.com/communities/114958480887231067224)\nto discuss with other user and developers.\n\n## Acknowledgements\n\nOpenJSCAD and its sub components are built upon great open source work, contribution & modules\n- [csg.js](https://github.com/jscad/csg.js) core & improvements by\nEvan Wallace,\nEduard Bespalov,\nJoost Nieuwenhuijse,\nAlexandre Girard\n\nFor input/output\n- [xmldom](https://github.com/jindw/xmldom)\n- [sax](https://github.com/isaacs/sax-js)\n\nTooling:\n- [browserify](http://browserify.org/)\n- [babel](https://babeljs.io/)\n\nand many more!\n\n## Backers\n\nThank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/openjscad#backer)]\n\n

\n\n\n## Sponsors\n\nSupport this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/openjscad#sponsor)]\n\n

\n\n\n\n## License\n\n[The MIT License (MIT)](https://github.com/jscad/OpenJSCAD.org/blob/master/LICENSE)\n(unless specified otherwise)\n\n## Screenshots\n\nSimple JSCAD example ([logo.jscad](examples/logo.jscad)) [try it](http://openjscad.org/#examples/logo.jscad):\n

\n\nMore sophisticated JSCAD example, with functions dedicated to object generation and with interactive parameters ([gear.jscad](examples/gear.jscad)) [try it](http://openjscad.org/#examples/gear.jscad) :\n

\n\nImport of STL models ([frog-OwenCollins.stl](examples/frog-OwenCollins.stl)) [try it](http://openjscad.org/#examples/frog-OwenCollins.stl):\n

\n\nDrag & drop a local file:\n

\n\nDrag & drop multiple files (Chrome & Firefox) or a folder (Chrome):\n

\n\n## See Also\n\n- [OpenJsCAD](http://joostn.github.com/OpenJsCad/), starting point of OpenJSCAD.org\n- [OpenSCAD.net](http://garyhodgson.github.com/openscad.net/), another place of inspiration, where the OpenSCAD translator was adapted from\n- [CoffeeSCad](http://kaosat-dev.github.com/CoffeeSCad/), JavaScript simplified (no more {}) (defunct)\n- [stl2pov](http://rsmith.home.xs4all.nl/software/py-stl-stl2pov.htmltool) to convert .stl to .pov, and then render via [PovRay.org](http://povray.org)\n- [P3D](https://github.com/D1plo1d/p3d) STL/AMF/OBJ viewer\n\nThat's all for now,\n\nRene K. Mueller, Jeff Gay, Mark Moissette & JSCAD Organization\n","has_starred","hub_user","immutable_tags_settings",{"_75":11,"_76":77},"enabled","rules",[78],".*","is_automated","permissions",{"_82":21,"_83":11,"_84":11},"read","write","admin","user","storage_size",393209754,"orgData",{"_90":91,"_92":93,"_94":95,"_96":33,"_97":33,"_98":99,"_100":101,"_102":99,"_103":104,"_105":99,"_106":99,"_107":99,"_108":21},"id","42c8025a74c011e4bea40242ac11001b","uuid","42c8025a-74c0-11e4-bea4-0242ac11001b","type","organization","orgname","full_name","location","","company","MID Academic Promotions Inc.","profile_url","date_joined","2014-02-28T04:16:28.679074Z","gravatar_url","gravatar_email","badge","is_active","recentTags",[111],{"_112":44,"_113":114,"_115":116,"_90":117,"_118":119,"_50":136,"_137":114,"_138":33,"_139":56,"_57":140,"_141":142,"_143":127,"_144":136,"_145":66,"_146":21},"content_type","creator",13523,"full_size",26216493,14800673,"images",[120],{"_121":122,"_123":124,"_125":99,"_126":127,"_128":129,"_130":131,"_132":99,"_133":-5,"_134":116,"_63":66,"_135":-5},"architecture","amd64","digest","sha256:cfccebd302397205f70a208865dc51ceef4e165d1250a14fc37764209b7b48f9","features","last_pulled","2026-09-29T22:18:04.489579649Z","last_pushed","2018-03-29T06:14:39Z","os","linux","os_features","os_version","size","variant","2018-03-29T06:14:38.086026Z","last_updater","last_updater_username","media_type","latest","repository",1786545,"tag_last_pulled","tag_last_pushed","tag_status","v2","sbxKitMetadata","isPotentialSpam","isHubSbxKitsEnabled","showSbxLogoOverride","sbxTrademarkText","displaySecurityMetadata","tagAttestations","tagsHaveAttestations",[],"selectedTag","attestationsUrl","routes/_layout.r.$namespace.$reponame.tags",{"_38":160,"_167":168,"_154":177,"_178":11},{"_40":161,"_42":162,"_45":46,"_47":48,"_49":11,"_50":51,"_52":53,"_54":163,"_57":35,"_32":33,"_58":59,"_60":44,"_61":62,"_63":64,"_65":66,"_67":-5,"_68":62,"_69":70,"_71":11,"_72":33,"_73":164,"_79":21,"_80":166,"_85":33,"_86":87},[],[44],[56],{"_75":11,"_76":165},[78],{"_82":21,"_83":11,"_84":11},"tags",{"_169":64,"_170":-5,"_171":-5,"_172":173},"count","next","previous","results",[174],{"_112":44,"_113":114,"_115":116,"_90":117,"_118":175,"_50":136,"_137":114,"_138":33,"_139":56,"_57":140,"_141":142,"_143":127,"_144":136,"_145":66,"_146":21},[176],{"_121":122,"_123":124,"_125":99,"_126":127,"_128":129,"_130":131,"_132":99,"_133":-5,"_134":116,"_63":66,"_135":-5},[],"canDeleteTags","actionData","errors"]

devrt/openjscad

Tags for devrt/openjscad