jscad-now

Instantly view a jscad V2 module

Usage no npm install needed!

<script type="module">
  import jscadNow from 'https://cdn.skypack.dev/jscad-now';
</script>

README

jscad-now

🧱👀 Instantly view a jscad V2 module

jscad-now

jscad-now is a live reloading viewer powered by budo and browserify and the @jscad/regl-renderer. It is an offline way to help you develop your local jscad models.

Installation

This tool is meant to be installed globally on your machine, so that you can invoke it in any folder where you are developing a model.

npm install -g jscad-now

Usage

Navigate a terminal to any jscad project folder. Enter:

jscad-now <path-to-your-jscad-file>.js

A local web server starts, and a browser appears where you can view your model and adjust its parameters.

Press ENTER in the terminal when you are finished viewing to stop the server and clean up the temp file.

Features

  • Use your own code editor.
  • Offline: Install it once and unplug. It's there for you when you need it.
  • Debuggable: You can debug and set breakpoints in your code with standard F12 developer tools in your browser. All computation is done on the UI thread, so you can find your own code without looking at worker threads. Note: this also means the browser won't be interactive until your model code completes.
  • Live reload: Save your file and the page will automatically reload.
  • Bundling: Browserify loads all your code's dependencies (like @jscad-modeling, etc.) the Node.js way.

To-do

  1. Download the current model via @jscad/io
  2. Configurable port number (run multiple instances)
  3. Parameter type coercion
  4. Keep camera position between reloads