@jscad/regl-renderer 2.6.12 → 3.0.1-alpha.0

package/CHANGELOG.md

@@ -3,302 +3,156 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
-## [2.6.12](https://github.com/jscad/OpenJSCAD.org/compare/@jscad/regl-renderer@2.6.11...@jscad/regl-renderer@2.6.12) (2024-12-29)
-
-**Note:** Version bump only for package @jscad/regl-renderer
-
-
-
-
-
-## [2.6.11](https://github.com/jscad/OpenJSCAD.org/compare/@jscad/regl-renderer@2.6.10...@jscad/regl-renderer@2.6.11) (2024-11-10)
-
-**Note:** Version bump only for package @jscad/regl-renderer
-
-
-
-
-
-## [2.6.10](https://github.com/jscad/OpenJSCAD.org/compare/@jscad/regl-renderer@2.6.9...@jscad/regl-renderer@2.6.10) (2024-10-06)
-
-**Note:** Version bump only for package @jscad/regl-renderer
-
-
-
-
-
-## [2.6.9](https://github.com/jscad/OpenJSCAD.org/compare/@jscad/regl-renderer@2.6.8...@jscad/regl-renderer@2.6.9) (2024-06-02)
-
-**Note:** Version bump only for package @jscad/regl-renderer
-
-
-
-
-
-## [2.6.8](https://github.com/jscad/OpenJSCAD.org/compare/@jscad/regl-renderer@2.6.7...@jscad/regl-renderer@2.6.8) (2024-02-18)
-
+## [3.0.1-alpha.0](https://github.com/jscad/OpenJSCAD.org/compare/@jscad/regl-renderer@2.6.3...@jscad/regl-renderer@3.0.1-alpha.0) (2025-01-03)
 
 ### Bug Fixes
 
-* **regl-renderer:** define the entity type and corrected TS definitions ([d7dc4fb](https://github.com/jscad/OpenJSCAD.org/commit/d7dc4fb3722652362d2a209b2c82adc8cbf7ad33))
+* **regl-renderer:** define the entity type and corrected TS definitions ([156929b](https://github.com/jscad/OpenJSCAD.org/commit/156929bbbeae028e91b5b4bc1d1fda682931af06))
+
+### Features
 
+* **regl-renderer:** added rollup configuration to create ES6 bundle, adjusted imports and exports ([#1259](https://github.com/jscad/OpenJSCAD.org/issues/1259)) ([47a66bc](https://github.com/jscad/OpenJSCAD.org/commit/47a66bc07a137a748ce8571ea5d043ebaab9418d))
 
+# [3.0.0-alpha.0](https://github.com/jscad/OpenJSCAD.org/compare/@jscad/regl-renderer@2.6.3...@jscad/regl-renderer@3.0.0-alpha.0) (2023-10-09)
 
+### Features
 
+* **regl-renderer:** added rollup configuration to create ES6 bundle, adjusted imports and exports ([#1259](https://github.com/jscad/OpenJSCAD.org/issues/1259)) ([47a66bc](https://github.com/jscad/OpenJSCAD.org/commit/47a66bc07a137a748ce8571ea5d043ebaab9418d))
 
 ## [2.6.7](https://github.com/jscad/OpenJSCAD.org/compare/@jscad/regl-renderer@2.6.6...@jscad/regl-renderer@2.6.7) (2023-06-27)
 
 **Note:** Version bump only for package @jscad/regl-renderer
 
-
-
-
-
 ## [2.6.6](https://github.com/jscad/OpenJSCAD.org/compare/@jscad/regl-renderer@2.6.5...@jscad/regl-renderer@2.6.6) (2023-04-30)
 
 **Note:** Version bump only for package @jscad/regl-renderer
 
-
-
-
-
 ## [2.6.5](https://github.com/jscad/OpenJSCAD.org/compare/@jscad/regl-renderer@2.6.4...@jscad/regl-renderer@2.6.5) (2023-01-09)
 
-
 ### Bug Fixes
 
 * **regl-renderer:** corrected rendering of overlapping transparent solid objects ([9a66b2a](https://github.com/jscad/OpenJSCAD.org/commit/9a66b2abaccb6f047c5e4c4505218e7bbac69018))
 
-
-
-
-
 ## [2.6.4](https://github.com/jscad/OpenJSCAD.org/compare/@jscad/regl-renderer@2.6.3...@jscad/regl-renderer@2.6.4) (2022-11-26)
 
 **Note:** Version bump only for package @jscad/regl-renderer
 
-
-
-
-
 ## [2.6.3](https://github.com/jscad/OpenJSCAD.org/compare/@jscad/regl-renderer@2.6.2...@jscad/regl-renderer@2.6.3) (2022-08-21)
 
 **Note:** Version bump only for package @jscad/regl-renderer
 
-
-
-
-
 ## [2.6.2](https://github.com/jscad/OpenJSCAD.org/compare/@jscad/regl-renderer@2.6.1...@jscad/regl-renderer@2.6.2) (2022-07-17)
 
 **Note:** Version bump only for package @jscad/regl-renderer
 
-
-
-
-
 ## [2.6.1](https://github.com/jscad/OpenJSCAD.org/compare/@jscad/regl-renderer@2.6.0...@jscad/regl-renderer@2.6.1) (2022-06-12)
 
 **Note:** Version bump only for package @jscad/regl-renderer
 
-
-
-
-
 # [2.6.0](https://github.com/jscad/OpenJSCAD.org/compare/@jscad/regl-renderer@2.5.9...@jscad/regl-renderer@2.6.0) (2022-05-15)
 
-
 ### Features
 
 * **regl-renderer:** added support for multicolor lines ([#1060](https://github.com/jscad/OpenJSCAD.org/issues/1060)) ([d5eb65b](https://github.com/jscad/OpenJSCAD.org/commit/d5eb65b298afcabd4231236c3aa5d5cc092db8d4))
 
-
-
-
-
 ## [2.5.9](https://github.com/jscad/OpenJSCAD.org/compare/@jscad/regl-renderer@2.5.8...@jscad/regl-renderer@2.5.9) (2022-04-24)
 
-
 ### Bug Fixes
 
 * **regl-render:** removed unnecessary preventDefault in demo.html ([#1068](https://github.com/jscad/OpenJSCAD.org/issues/1068)) ([b2ff7c3](https://github.com/jscad/OpenJSCAD.org/commit/b2ff7c33cd3a8a0fc242b42f5e4bb2690eaef081))
 
-
 ### Performance Improvements
 
 * **modeling:** faster geom2.toOutlines ([#1064](https://github.com/jscad/OpenJSCAD.org/issues/1064)) ([5cb2f65](https://github.com/jscad/OpenJSCAD.org/commit/5cb2f652fa099593e6ec133fe879ecf8a09705e9))
 
-
-
-
-
 ## [2.5.8](https://github.com/jscad/OpenJSCAD.org/compare/@jscad/regl-renderer@2.5.7...@jscad/regl-renderer@2.5.8) (2022-04-03)
 
 **Note:** Version bump only for package @jscad/regl-renderer
 
-
-
-
-
 ## [2.5.7](https://github.com/jscad/OpenJSCAD.org/compare/@jscad/regl-renderer@2.5.6...@jscad/regl-renderer@2.5.7) (2022-04-03)
 
 **Note:** Version bump only for package @jscad/regl-renderer
 
-
-
-
-
 ## [2.5.6](https://github.com/jscad/OpenJSCAD.org/compare/@jscad/regl-renderer@2.5.5...@jscad/regl-renderer@2.5.6) (2022-03-13)
 
 **Note:** Version bump only for package @jscad/regl-renderer
 
-
-
-
-
 ## [2.5.5](https://github.com/jscad/OpenJSCAD.org/compare/@jscad/regl-renderer@2.5.4...@jscad/regl-renderer@2.5.5) (2022-03-06)
 
 **Note:** Version bump only for package @jscad/regl-renderer
 
-
-
-
-
 ## [2.5.4](https://github.com/jscad/OpenJSCAD.org/compare/@jscad/regl-renderer@2.5.3...@jscad/regl-renderer@2.5.4) (2022-02-19)
 
 **Note:** Version bump only for package @jscad/regl-renderer
 
-
-
-
-
 ## [2.5.3](https://github.com/jscad/OpenJSCAD.org/compare/@jscad/regl-renderer@2.5.2...@jscad/regl-renderer@2.5.3) (2021-12-26)
 
 **Note:** Version bump only for package @jscad/regl-renderer
 
-
-
-
-
 ## [2.5.2](https://github.com/jscad/OpenJSCAD.org/compare/@jscad/regl-renderer@2.5.1...@jscad/regl-renderer@2.5.2) (2021-12-11)
 
 **Note:** Version bump only for package @jscad/regl-renderer
 
-
-
-
-
 ## [2.5.1](https://github.com/jscad/OpenJSCAD.org/compare/@jscad/regl-renderer@2.5.0...@jscad/regl-renderer@2.5.1) (2021-11-07)
 
 **Note:** Version bump only for package @jscad/regl-renderer
 
-
-
-
-
 # [2.5.0](https://github.com/jscad/OpenJSCAD.org/compare/@jscad/regl-renderer@2.4.1...@jscad/regl-renderer@2.5.0) (2021-10-17)
 
-
 ### Features
 
 * **web:** changed default serialize to false, eliminating JSON serialize/deserialize ([#928](https://github.com/jscad/OpenJSCAD.org/issues/928)) ([b29993a](https://github.com/jscad/OpenJSCAD.org/commit/b29993a8fd3da3bd43a5f871edae4c60d7f56fc7))
 
-
-
-
-
 ## [2.4.1](https://github.com/jscad/OpenJSCAD.org/compare/@jscad/regl-renderer@2.4.0...@jscad/regl-renderer@2.4.1) (2021-10-04)
 
 **Note:** Version bump only for package @jscad/regl-renderer
 
-
-
-
-
 # [2.4.0](https://github.com/jscad/OpenJSCAD.org/compare/@jscad/regl-renderer@2.3.0...@jscad/regl-renderer@2.4.0) (2021-09-27)
 
-
 ### Features
 
 * **regl-renderer:** enhanced rendering to use the matrix as provided with the geometry ([#871](https://github.com/jscad/OpenJSCAD.org/issues/871)) ([40802af](https://github.com/jscad/OpenJSCAD.org/commit/40802afeb9a2a45cf3eb4f1b9dc774b8670d8259))
 
-
-
-
-
 # [2.3.0](https://github.com/jscad/OpenJSCAD.org/compare/@jscad/regl-renderer@2.2.0...@jscad/regl-renderer@2.3.0) (2021-09-09)
 
-
 ### Features
 
 * **regl-renderer:** typescript definitions and generator. ([#801](https://github.com/jscad/OpenJSCAD.org/issues/801)) ([1616876](https://github.com/jscad/OpenJSCAD.org/commit/16168761c53bbb6ffb604aa69c9c80dcc13eaad3))
 
-
-
-
-
 # [2.2.0](https://github.com/jscad/OpenJSCAD.org/compare/@jscad/regl-renderer@2.1.3...@jscad/regl-renderer@2.2.0) (2021-06-20)
 
-
 ### Features
 
 * **regl-renderer:** added new command drawLines, and adjusted demos ([#863](https://github.com/jscad/OpenJSCAD.org/issues/863)) ([02b5247](https://github.com/jscad/OpenJSCAD.org/commit/02b524775165f743b1f0bcecce92a0f7784bb89b))
 
-
-
-
-
 ## [2.1.3](https://github.com/jscad/OpenJSCAD.org/compare/@jscad/regl-renderer@2.1.2...@jscad/regl-renderer@2.1.3) (2021-06-11)
 
 **Note:** Version bump only for package @jscad/regl-renderer
 
-
-
-
-
 ## [2.1.2](https://github.com/jscad/OpenJSCAD.org/compare/@jscad/regl-renderer@2.1.1...@jscad/regl-renderer@2.1.2) (2021-06-01)
 
 **Note:** Version bump only for package @jscad/regl-renderer
 
-
-
-
-
 ## [2.1.1](https://github.com/jscad/OpenJSCAD.org/compare/@jscad/regl-renderer@2.1.0...@jscad/regl-renderer@2.1.1) (2021-05-16)
 
-
 ### Bug Fixes
 
 * **regl-renderer:** added reasonable defaults for drawGrid ([d64e062](https://github.com/jscad/OpenJSCAD.org/commit/d64e06228f8a92e014df3e22ea9ee48e11825420))
 * **regl-renderer:** corrected conversion of empty solids to entities, updated tests ([967fe82](https://github.com/jscad/OpenJSCAD.org/commit/967fe82ea429af14fe23a51d19099b1752ceead3))
 * **regl-renderer:** corrected determination of camera position change in orbitControls ([4f467c5](https://github.com/jscad/OpenJSCAD.org/commit/4f467c5d92132dc140db6799766f3a98716e5d68))
 
-
-
-
-
 # [2.1.0](https://github.com/jscad/OpenJSCAD.org/compare/@jscad/regl-renderer@2.0.3...@jscad/regl-renderer@2.1.0) (2021-04-30)
 
-
 ### Features
 
 * **regl-renderer:** refactored and corrected conversions of solids to entities, supporting HUGE solids ([#797](https://github.com/jscad/OpenJSCAD.org/issues/797)) ([f8baa22](https://github.com/jscad/OpenJSCAD.org/commit/f8baa222e89ac9357c795620b7f21341e202ad74))
 
-
-
-
-
 ## [2.0.3](https://github.com/jscad/OpenJSCAD.org/compare/@jscad/regl-renderer@2.0.2...@jscad/regl-renderer@2.0.3) (2021-04-20)
 
 **Note:** Version bump only for package @jscad/regl-renderer
 
-
-
-
-
 ## [2.0.2](https://github.com/jscad/OpenJSCAD.org/compare/@jscad/regl-renderer@2.0.0-alpha.0...@jscad/regl-renderer@2.0.2) (2021-04-17)
 
-
 ### Bug Fixes
 
 * **all:** support sparse arrays from main() ([#672](https://github.com/jscad/OpenJSCAD.org/issues/672)) ([209961d](https://github.com/jscad/OpenJSCAD.org/commit/209961d41ebf77373d427a7986934d195780f118))
@@ -307,13 +161,8 @@ See [Conventional Commits](https://conventionalcommits.org) for commit guideline
 * **regl-renderer:** corrected zoomToFit for 2D geometries ([#793](https://github.com/jscad/OpenJSCAD.org/issues/793)) ([2a05d3e](https://github.com/jscad/OpenJSCAD.org/commit/2a05d3e9b380e8782148c5d158c40715d6af2cd8))
 * **regl-renderer:** variable distance in pan controls ([#735](https://github.com/jscad/OpenJSCAD.org/issues/735)) ([9ad661c](https://github.com/jscad/OpenJSCAD.org/commit/9ad661c44cb87ee6ae58f20a69eaad5fd83a05a6))
 
-
-
-
-
 ## [2.0.1](https://github.com/jscad/OpenJSCAD.org/compare/@jscad/regl-renderer@2.0.0-alpha.0...@jscad/regl-renderer@2.0.1) (2021-04-15)
 
-
 ### Bug Fixes
 
 * **all:** support sparse arrays from main() ([#672](https://github.com/jscad/OpenJSCAD.org/issues/672)) ([209961d](https://github.com/jscad/OpenJSCAD.org/commit/209961d41ebf77373d427a7986934d195780f118))
@@ -322,143 +171,77 @@ See [Conventional Commits](https://conventionalcommits.org) for commit guideline
 * **regl-renderer:** corrected zoomToFit for 2D geometries ([#793](https://github.com/jscad/OpenJSCAD.org/issues/793)) ([2a05d3e](https://github.com/jscad/OpenJSCAD.org/commit/2a05d3e9b380e8782148c5d158c40715d6af2cd8))
 * **regl-renderer:** variable distance in pan controls ([#735](https://github.com/jscad/OpenJSCAD.org/issues/735)) ([9ad661c](https://github.com/jscad/OpenJSCAD.org/commit/9ad661c44cb87ee6ae58f20a69eaad5fd83a05a6))
 
-
-
-
-
 # [2.0.0](https://github.com/jscad/OpenJSCAD.org/compare/@jscad/regl-renderer@2.0.0-alpha.13...@jscad/regl-renderer@2.0.0) (2021-04-12)
 
 **Note:** Version bump only for package @jscad/regl-renderer
 
-
-
-
-
 # [2.0.0-alpha.13](https://github.com/jscad/OpenJSCAD.org/compare/@jscad/regl-renderer@2.0.0-alpha.12...@jscad/regl-renderer@2.0.0-alpha.13) (2021-03-07)
 
 **Note:** Version bump only for package @jscad/regl-renderer
 
-
-
-
-
 # [2.0.0-alpha.12](https://github.com/jscad/OpenJSCAD.org/compare/@jscad/regl-renderer@2.0.0-alpha.11...@jscad/regl-renderer@2.0.0-alpha.12) (2021-02-07)
 
 **Note:** Version bump only for package @jscad/regl-renderer
 
-
-
-
-
 # [2.0.0-alpha.11](https://github.com/jscad/OpenJSCAD.org/compare/@jscad/regl-renderer@2.0.0-alpha.10...@jscad/regl-renderer@2.0.0-alpha.11) (2021-01-02)
 
 **Note:** Version bump only for package @jscad/regl-renderer
 
-
-
-
-
 # [2.0.0-alpha.10](https://github.com/jscad/OpenJSCAD.org/compare/@jscad/regl-renderer@2.0.0-alpha.9...@jscad/regl-renderer@2.0.0-alpha.10) (2020-12-04)
 
-
 ### Bug Fixes
 
 * **regl-renderer:** variable distance in pan controls ([#735](https://github.com/jscad/OpenJSCAD.org/issues/735)) ([9ad661c](https://github.com/jscad/OpenJSCAD.org/commit/9ad661c44cb87ee6ae58f20a69eaad5fd83a05a6))
 
-
-
-
-
 # [2.0.0-alpha.9](https://github.com/jscad/OpenJSCAD.org/compare/@jscad/regl-renderer@2.0.0-alpha.8...@jscad/regl-renderer@2.0.0-alpha.9) (2020-11-07)
 
-
 ### Bug Fixes
 
 * **regl-renderer:** Changes to improve regl-renderer ([#722](https://github.com/jscad/OpenJSCAD.org/issues/722)) ([7bcc689](https://github.com/jscad/OpenJSCAD.org/commit/7bcc689e3d36cfbc3ac6f9b4c3822a72d54a996e))
 
-
-
-
-
 # [2.0.0-alpha.8](https://github.com/jscad/OpenJSCAD.org/compare/@jscad/regl-renderer@2.0.0-alpha.7...@jscad/regl-renderer@2.0.0-alpha.8) (2020-10-11)
 
-
 ### Bug Fixes
 
 * **all:** V2 : several fixes for modeling ([#705](https://github.com/jscad/OpenJSCAD.org/issues/705)) ([62017a4](https://github.com/jscad/OpenJSCAD.org/commit/62017a41214169d6e000f1e0c11aaefdd68e1097))
 
-
-
-
-
 # [2.0.0-alpha.7](https://github.com/jscad/OpenJSCAD.org/compare/@jscad/regl-renderer@2.0.0-alpha.6...@jscad/regl-renderer@2.0.0-alpha.7) (2020-09-29)
 
 **Note:** Version bump only for package @jscad/regl-renderer
 
-
-
-
-
 # [2.0.0-alpha.6](https://github.com/jscad/OpenJSCAD.org/compare/@jscad/regl-renderer@2.0.0-alpha.5...@jscad/regl-renderer@2.0.0-alpha.6) (2020-09-28)
 
 **Note:** Version bump only for package @jscad/regl-renderer
 
-
-
-
-
 # [2.0.0-alpha.5](https://github.com/jscad/OpenJSCAD.org/compare/@jscad/regl-renderer@2.0.0-alpha.4...@jscad/regl-renderer@2.0.0-alpha.5) (2020-09-19)
 
-
 ### Bug Fixes
 
 * **all:** support sparse arrays from main() ([#672](https://github.com/jscad/OpenJSCAD.org/issues/672)) ([209961d](https://github.com/jscad/OpenJSCAD.org/commit/209961d41ebf77373d427a7986934d195780f118))
 
-
-
-
-
 # [2.0.0-alpha.4](https://github.com/jscad/OpenJSCAD.org/compare/@jscad/regl-renderer@2.0.0-alpha.3...@jscad/regl-renderer@2.0.0-alpha.4) (2020-09-08)
 
 **Note:** Version bump only for package @jscad/regl-renderer
 
-
-
-
-
 # [2.0.0-alpha.3](https://github.com/jscad/OpenJSCAD.org/compare/@jscad/regl-renderer@2.0.0-alpha.2...@jscad/regl-renderer@2.0.0-alpha.3) (2020-09-02)
 
 **Note:** Version bump only for package @jscad/regl-renderer
 
-
-
-
-
 # [2.0.0-alpha.2](https://github.com/jscad/OpenJSCAD.org/compare/@jscad/regl-renderer@2.0.0-alpha.1...@jscad/regl-renderer@2.0.0-alpha.2) (2020-08-26)
 
 * **regl-renderer:** various fixes to renderer
 
-
-
-
-
 # [2.0.0-alpha.1](https://github.com/jscad/OpenJSCAD.org/compare/@jscad/regl-renderer@2.0.0-alpha.0...@jscad/regl-renderer@2.0.0-alpha.1) (2020-08-19)
 
 **Note:** Version bump only for package @jscad/regl-renderer
 
-
-
-
-
 # 2.0.0-alpha.0 (2020-08-13)
 
-
 ### Bug Fixes
 
 * **regl-renderer:** small tweaks and fixes for V2 ([#484](https://github.com/jscad/OpenJSCAD.org/issues/484)) ([ee50200](https://github.com/jscad/OpenJSCAD.org/commit/ee50200bfcacd8078fa6f1fd73f6cd866afce5ed))
 * **regl-renderer:** implemented an alternative caching scheme in render
 
-
 ### Features
 
 * **regl-renderer:** Overhaul and V2 groundwork ([#425](https://github.com/jscad/OpenJSCAD.org/issues/425)) ([7ccc789](https://github.com/jscad/OpenJSCAD.org/commit/7ccc7898ddf98f0cf9425a67a8ffdf79ebb82b2a))

package/LICENSE

@@ -1,7 +1,7 @@
 
 The MIT License (MIT)
 
-Copyright (c) 2017-2024 JSCAD Organization
+Copyright (c) 2017-2025 JSCAD Organization
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -9,7 +9,7 @@
 [![License](https://img.shields.io/github/license/jscad/OpenJSCAD.org)](https://github.com/jscad/OpenJSCAD.org/blob/master/LICENSE)
 
 [![User Group](https://img.shields.io/badge/maintained%20by-user%20group-blue)](https://openjscad.nodebb.com/)
-[![Lerna](https://img.shields.io/badge/maintained%20with-lerna-blue)](https://lerna.js.org/)
+[![lerna--lite](https://img.shields.io/badge/maintained%20with-lerna--lite-e137ff)](https://github.com/ghiscoding/lerna-lite)
 [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-blue)](https://standardjs.com)
 
 [![Backers](https://img.shields.io/opencollective/backers/openjscad)](https://opencollective.com/openjscad)
@@ -32,40 +32,50 @@ npm install @jscad/regl-renderer
 ```
 
 In addition this package is hosted at [UNPKG](https://unpkg.com/), and can be imported directly into webpages.
-
 ```
-<script language="javascript" src="https://unpkg.com/@jscad/regl-renderer"</script>
+  <script type="module" id="MODELING">
+import { cameras, commands, controls, entitiesFromSolids, prepareRender } from "./dist/jscad-regl-renderer.es.js"
+
+... YOUR CODE
+  </script>
 ```
 
 ## Usage
 
-### Node.js (headless)
+### Node.js (HEADLESS)
 
 Install the following packages manually.
 
 NOTE: There are issues with continous integration testing, so 'gl' is not installed initially.
 
 ```
- npm install gl
+pnpm install gl
 ```
 
-Try the demo by running ```npm run demo-cli```.
+Try the demo by running ```pnpm run demo-cli```.
 
 If all goes well you should end up with an image (test.png) that renders the demo design.
 
-The demo code can be found in 'demo-cli.js'
+The source code of the demo can be found in 'demo-cli.js'
 
 ### Browsers
 
-From a browser, try opening the file 'demo.html'. This should show the demo design.
+This module has been tested using several browsers, includig Firefox, Chrome, Safari, etc.
+For an exmple of how to use the module, please see 'demo.es.html'
+
+NOTE: 'demo.es.html' cannot be opened from the local file system. This is due to CORS security limitiations. See the next section.
 
 ### Developers
 
-Run the development web server using ```npm run dev```, then open the URL shown.
+Run the development web server using ```pnpm run dev```, then open the URL shown using any browser.
+From the index of files, select 'demo.es.html'.
+
+If all goes well you should end up with a web page that displays the demo design (a few solids).
+The standard mouse controls are also available for rotation, etc.
 
-If all goes well you should end up with a web page with a rotating camera (no mouse controls) that displays the demo design (a few solids).
+After making changes, just reload the web page.
 
-After making changes, all tests must pass. Run ```npm test```
+If making changes, please make sure that all tests must pass. Run ```pnpm test```
 
 ## License
 

package/demo-cli.js

@@ -1,12 +1,16 @@
-const { writeContextToFile } = require('@jscad/img-utils')
+import gl from 'gl'
 
-const { prepareRender, drawCommands, cameras, entitiesFromSolids } = require('./src') // replace this with the correct import
+import { colors, primitives, booleans } from '@jscad/modeling'
+
+import { writeContextToFile } from '@jscad/img-utils'
+
+import { prepareRender, commands, cameras, entitiesFromSolids } from './dist/jscad-regl-renderer.es.js'
 
 // setup demo solids data
 const demoSolids = (parameters) => {
-  const { colorize } = require('@jscad/modeling').colors
-  const { cube, cuboid, line, sphere, star } = require('@jscad/modeling').primitives
-  const { intersect, subtract } = require('@jscad/modeling').booleans
+  const { colorize } = colors
+  const { cube, cuboid, line, sphere, star } = primitives
+  const { intersect, subtract } = booleans
 
   const logo = [
     colorize([1.0, 0.4, 1.0], subtract(
@@ -30,8 +34,8 @@ const demoSolids = (parameters) => {
     [0, 1, 0],
     [0, 0, 0.7]
   ]
-  star2D.sides.forEach((side, i) => {
-    if (i >= 2) side.color = colorChange[i % colorChange.length]
+  star2D.outlines.forEach((outline, i) => {
+    outline.color = colorChange[i % colorChange.length]
   })
 
   return [transpCube, star2D, line2D, ...logo]
@@ -45,7 +49,7 @@ const params = {
 const { width, height } = params
 
 // create webgl context
-const gl = require('gl')(width, height)
+const context = gl(width, height)
 
 // process entities and inject extras
 const entities = entitiesFromSolids({}, demoSolids({ scale: 1 }))
@@ -57,14 +61,14 @@ perspectiveCamera.setProjection(camera, camera, { width, height })
 perspectiveCamera.update(camera, camera)
 
 const options = {
-  glOptions: { gl },
+  glOptions: { gl: context },
   camera,
   drawCommands: {
     // draw commands bootstrap themselves the first time they are run
-    drawAxis: drawCommands.drawAxis,
-    drawGrid: drawCommands.drawGrid,
-    drawLines: drawCommands.drawLines,
-    drawMesh: drawCommands.drawMesh
+    drawAxis: commands.drawAxis,
+    drawGrid: commands.drawGrid,
+    drawLines: commands.drawLines,
+    drawMesh: commands.drawMesh
   },
   rendering: {
     background: [1, 1, 1, 1],
@@ -109,9 +113,9 @@ const options = {
   ]
 }
 
-// prepare
+// render the contents
 const render = prepareRender(options)
-// do the actual render
 render(options)
+
 // output to file
-writeContextToFile(gl, width, height, 4, './test.png')
+writeContextToFile(context, width, height, 4, './test.png')

package/demo-web.js

@@ -1,10 +1,12 @@
-const { prepareRender, drawCommands, cameras, entitiesFromSolids } = require('./src')
+import { prepareRender, drawCommands, cameras, entitiesFromSolids } from './src/index.js'
+
+import { colors, primitives, booleans } from '@jscad/modeling'
 
 // setup demo solids data
 const demoSolids = (parameters) => {
-  const { colorize } = require('@jscad/modeling').colors
-  const { cube, cuboid, line, sphere, star } = require('@jscad/modeling').primitives
-  const { intersect, subtract } = require('@jscad/modeling').booleans
+  const { colorize } = colors
+  const { cube, cuboid, line, sphere, star } = primitives
+  const { intersect, subtract } = booleans
 
   const logo = [
     colorize([1.0, 0.4, 1.0], subtract(