Profile
Back to NewsBack
GitHub Trending 3 min
Reader Mode
openscad/openscad-playground: OpenSCAD Web Playground

openscad/openscad-playground: OpenSCAD Web Playground

12 hours ago

OpenSCAD Playground

Open the Demo

image

This is a limited port of OpenSCAD to WebAssembly, using at its core a headless WASM build of OpenSCAD (done by @DSchroer), wrapped in a UI made of pretty PrimeReact components, a React Monaco editor (VS Codesque power!), and an interactive model-viewer renderer.

It defaults to the Manifold backend so it's super fast.

Enjoy!

Licenses: see LICENSES.

Features

  • Automatic preview on edit (F5), and full rendering on Ctrl+Enter (or F6). Using a trick to force $preview=true.
  • Customizer support
  • Syntax highlighting
  • Ships with many standard SCAD libraries (can browse through them in the UI)
  • Autocomplete of imports
  • Autocomplete of symbols / function calls (pseudo-parses file and its transitive imports)
  • Responsive layout. On small screens editor and viewer are stacked onto each other, while on larger screens they can be side-by-side
  • Installable as a PWA (then persists edits in localStorage instead of the hash fragment). On iOS just open the sharing panel and tap "Add to Home Screen". Should not require any internet connectivity once cached.

Roadmap

  • [x] Add tests!
  • [x] Persist camera state
  • [x] Support 2D somehow? (e.g. add option in OpenSCAD to output 2D geometry as non-closed polysets, or to auto-extrude by some height)
  • [x] Proper Preview rendering: have OpenSCAD export the preview scene to a rich format (e.g. glTF, with some parts being translucent when prefixed w/ % modifier) and display it using https://modelviewer.dev/ maybe)
  • ~~Rebuild w/ (and sync) ochafik@'s filtered kernel (https://github.com/openscad/openscad/pull/4160) to fix(ish) 2D operations~~
  • [x] Bundle more examples (ask users to contribute)
  • Animation rendering (And other formats than STL)
  • [x] Compress URL fragment
  • [x] Mobile (iOS) editing support: switch to https://www.npmjs.com/package/react-codemirror ?
  • [x] Replace Makefile w/ something that reads the libs metadata
  • [ ] Merge modifiers rendering code to openscad
  • Model /home fs in shared state. have two clear paths: /libraries for builtins, and /home for user data. State pointing to /libraries paths needs not store the data except if there's overrides (flagged as modifications in the file picker)
  • Drag and drop of files (SCAD, STL, etc) and Zip archives. For assets, auto insert the corresponding import.
  • Fuller PWA support w/ link Sharing, File opening / association to *.scad files...
  • Look into accessibility
  • Setup OPENSCADPATH env var w/ Emscripten to ensure examples that include assets / import local files will run fine.
  • Every bundled library is fetched on demand (by a render that refers to it, or when a file of it is opened from the file explorer); the file explorer and the use < / include < completions list all of them from the build-time libraries/index.json. Non-.scad assets and directories with no .scad file are not in the index (not listed in the explorer).
  • Preparse builtin libraries definitions at compile time, ship the JSON.

Building

The project uses a webpack-based build system that reads library metadata from libs-config.json to automatically download, clone, and package OpenSCAD libraries and dependencies. This replaces the previous Makefile approach with a more standard, maintainable solution.

Prerequisites:

  • wget or curl
  • Node.js (>=22)
  • npm
  • git
  • zip
  • Docker able to run amd64 containers (only needed if building WASM from source). If running on a different platform (including Silicon Mac), you can add support for amd64 images through QEMU with:
docker run --privileged --rm tonistiigi/binfmt --install all

Local dev:

npm run build:libs  # Download WASM and build all OpenSCAD libraries
npm install
npm run start

http://localhost:4000/

Local prod (test both the different inlining and serving under a prefix):

npm run build:libs  # Download WASM and build all OpenSCAD libraries
npm install
npm run start:production

http://localhost:3000/dist/

Deployment (edit "homepage" in package.json to match your deployment root!):

npm run build:all  # Build libraries and compile the application
npm install

rm -fR ../ochafik.github.io/openscad2 && cp -R dist ../ochafik.github.io/openscad2

Now commit and push changes, wait for site update and enjoy!

Libraries and fonts are pinned to exact commits in libs-config.json (commit fields), so builds are reproducible. To bump them to the current branch heads, run npm run libs:update, review the diff, and commit (npm run libs:check reports out-of-date pins without writing). Libraries with a stable release process (BOSL2, NopSCADlib) set a tag field instead: libs:update then pins the commit of that tag, and you bump the tag by hand.

Embedding

The playground can be embedded in any page with an iframe. When it runs inside a frame it defaults to embed mode: no tab bar or footer, just the 3D viewer filling the frame and one discreet toolbar in the top-right corner with: the customizer toggle (only when the model has customizer parameters), Download .scad (the active file's OpenSCAD source), fullscreen (if the host/iframe allows it) and an exit to the full UI. The customizer opens as a translucent side sheet docked on the right (about 360px, 85% of the width on small screens): it overlays the viewer without resizing it, stays non-modal on desktop (the model remains interactive), and closes with the toolbar toggle, Escape, or a tap outside on small screens. The exit switches to the full UI in place in a top-level window and opens the same state in a new tab (?embed=0) when framed.

A deployment that also serves the MCP endpoint (see docs/MCP_APP_DEPLOYMENT.md) can set the build-time variable OPENSCAD_MCP_URL (e.g. /mcp or an absolute URL): the settings menu then shows a Configure MCP entry opening that page in a new tab. It is hidden when unset, and when framed (embeds and the MCP app itself).

In the full UI, the settings menu has an Embed mode item (session-level: not saved in links or persisted) and Copy embed code, which copies an