cubing 0.25.2 → 0.25.6

package/README.md

@@ -11,66 +11,48 @@
 
 <a href="https://alpha.twizzle.net/"><img src="./src/sites/alpha.twizzle.net/twizzle-social-media-image.png" width="256">
 
-Twizzle</a> is the spiritual successor to [alg.cubing.net](https://alg.cubing.net/), based on `cubing.js`. It is currently being developed at [src/sites/alpha.twizzle.net](./src/sites/alpha.twizzle.net/).
-
-See the [Twizzle Diaries](https://www.youtube.com/watch?v=9_kqXn0Mq-o&list=PLFh3NgpDbzN4VkcfjEZSQ_TYQv_OEjbjF) video series for more information on Twizzle's vision and use cases.
+Twizzle</a> is the spiritual successor to [alg.cubing.net](https://alg.cubing.net/), based on `cubing.js`. It is currently being developed at [src/sites/alpha.twizzle.net](./src/sites/alpha.twizzle.net/). See the [Twizzle Diaries](https://www.youtube.com/watch?v=9_kqXn0Mq-o&list=PLFh3NgpDbzN4VkcfjEZSQ_TYQv_OEjbjF) video series for more information on Twizzle's vision and use cases.
 
 ## Getting started
 
-If you aren't sure where to get started, you should start with `cdn.cubing.net`, which lets you implement cubing.js in a website.
-
-If you're already comfortable with writing web apps using `npm`, see the "`Using with Node.js`" section below.
-
-The following code is a good way to get started with `cdn.cubing.net`:
+If you're just getting started, the easiest way to use `cubing.js` is throught `cdn.cubing.net`:
 
 ```html
 <script src="https://cdn.cubing.net/js/cubing/twisty" type="module"></script>
 <twisty-player alg="R U R' U R U2' R'"></twisty-player>
 ```
 
-You can find more documentation at [js.cubing.net/cubing/](https://js.cubing.net/cubing).  
-The source for the documentation site is currently inside the [docs](./docs/) folder of this repository.
+You can find more documentation at [js.cubing.net/cubing/](https://js.cubing.net/cubing).
 
-## Using with Node.js
+## Using with `node` and `npm`
 
-If you would like to use cubing.js as a library in your Node projects, make sure you have [node](https://nodejs.org/en/) and [npm](https://docs.npmjs.com/getting-started) installed (installing `node` will install `npm` as well). Once you have installed those, you can run:
+If you would like to use cubing.js as a library in your package-based projects, make sure you have [node](https://nodejs.org/en/) and [npm](https://docs.npmjs.com/getting-started) installed (installing `node` will install `npm` as well). Once you have installed those, you can run:
 
 ```shell
 npm install cubing
 ```
 
-The following modules are a good starting point:
+Then you can use modules like this:
 
-```shell
+```js
 import { Alg } from "cubing/alg";
 import { TwistyPlayer } from "cubing/twisty";
 ```
 
 ## Contributing
 
-## Developing `cubing.js`
+If you would like to contribute to the development of `cubing.js`, please refer to our [contribution guidelines](./CONTRIBUTING.md).
 
-If you would like to contribute to the development of `cubing.js`, please refer to our [contribution guidelines](CONTRIBUTING.md).
+## Developing `cubing.js` itself
 
-To work on the `cubing.js` source code, you'll need to install [`node`](https://nodejs.org/en/) and [npm](https://docs.npmjs.com/getting-started) (installing `node` will install `npm` as well). Once you have installed those, you can run:
+If you have `git`, `node`, and `npm` installed, you can run the `cubing.js` source like this (see the [contribution guidelines](./CONTRIBUTING.md) for more details):
 
 ```shell
 git clone https://github.com/cubing/cubing.js && cd cubing.js
 make dev
+# Now visit http://localhost:3333
 ```
 
-This should install a few dependencies and start the server, after which you can open <http://localhost:3333/>. Some tips:
-
-The core library code for `cubing.js` is in [`src/cubing`](./src/cubing/). To test changes, use:
-
-```shell
-make test
-```
-
-- See [`src/README.md`](./src/README.md) for the source code structure.
-  - The core library code for `cubing.js` is in [`src/cubing`](./src/cubing/).
-  - The code for Twizzle and dev experiments is in [`src/sites`](./src/sites/).
-
 ## Acknowledgments
 
 As of this time, `cubing.js` primarily contains code by [Lucas Garron (@lgarron)](https://github.com/lgarron) and [Tom Rokicki (@rokicki)](https://github.com/rokicki). Significant parts of the cubing code also are from:
@@ -78,7 +60,7 @@ As of this time, `cubing.js` primarily contains code by [Lucas Garron (@lgarron)
 - [Chen Shuang (@cs0x7f)](https://github.com/cs0x7f): Scramblers for 3x3x3, 4x4x4, and Square-1
 - [`xyxxy` (@torchlight)](https://github.com/torchlight): Scramblers for unofficial events
 
-It also uses the [`three.js`](https://github.com/mrdoob/three.js), [`comlink`](https://github.com/GoogleChromeLabs/comlink), and [`p-lazy`](https://github.com/sindresorhus/p-lazy) libraries.
+It also uses the [`three.js`](https://github.com/mrdoob/three.js), [`comlink`](https://github.com/GoogleChromeLabs/comlink), and [`p-lazy`](https://github.com/sindresorhus/p-lazy) libraries. Twizzle also uses the [Ubuntu font](https://design.ubuntu.com/font/).
 
 ## License
 

package/dist/esm/{2x2x2.sgs.json-NUOQFJWU.js → 2x2x2.sgs.json-GQVTWF7L.js}

@@ -3,8 +3,8 @@ import {
 } from "./chunk-27KJGD3S.js";
 import {
   cube2x2x2
-} from "./chunk-SNWS6JXI.js";
-import "./chunk-Y32HHZUY.js";
+} from "./chunk-BOKO2BWT.js";
+import "./chunk-FE3HTWQK.js";
 import "./chunk-EWRBHQFX.js";
 import "./chunk-WO2AXYFE.js";
 
@@ -119,4 +119,4 @@ export {
   cachedData222,
   data222
 };
-//# sourceMappingURL=2x2x2.sgs.json-NUOQFJWU.js.map
+//# sourceMappingURL=2x2x2.sgs.json-GQVTWF7L.js.map

package/dist/esm/{3d-dynamic-AKACURPM.js → 3d-dynamic-DKWMBHRS.js}

@@ -3,13 +3,13 @@ import {
   THREEJS,
   experimentalStickerings,
   hintFaceletStyles
-} from "./chunk-L3PZ4XAT.js";
+} from "./chunk-TG5KP5IL.js";
 import {
   cube3x3x3,
   getFaceletAppearance,
   puzzles
-} from "./chunk-SNWS6JXI.js";
-import "./chunk-Y32HHZUY.js";
+} from "./chunk-BOKO2BWT.js";
+import "./chunk-FE3HTWQK.js";
 import {
   Move
 } from "./chunk-EWRBHQFX.js";
@@ -1168,16 +1168,16 @@ var PG3D = class extends Object3D2 {
         for (let faceletIdx = 0; faceletIdx < orientations; faceletIdx++) {
           const faceletAppearance = getFaceletAppearance(appearance, orbitName, pieceIdx, faceletIdx, false);
           const stickerDef = this.stickers[orbitName][faceletIdx][pieceIdx];
-          stickerDef.setAppearance(this.filler, faceletAppearance);
+          if (this.textured && this.hintMaterialDisposable && faceletAppearance === "invisible") {
+          } else {
+            stickerDef.setAppearance(this.filler, faceletAppearance);
+          }
         }
       }
     }
-    if (this.scheduleRenderCallback) {
-      __privateSet(this, _pendingStickeringUpdate, true);
-      if (this.lastPos) {
-        this.onPositionChange(this.lastPos);
-      }
-      this.scheduleRenderCallback();
+    __privateSet(this, _pendingStickeringUpdate, true);
+    if (this.lastPos) {
+      this.onPositionChange(this.lastPos);
     }
   }
   onPositionChange(p) {
@@ -1221,7 +1221,6 @@ var PG3D = class extends Object3D2 {
         }
       }
       this.lastPos = p;
-      __privateSet(this, _pendingStickeringUpdate, false);
     }
     let vismods = 0;
     for (const moveProgress of p.movesInProgress) {
@@ -1278,17 +1277,18 @@ var PG3D = class extends Object3D2 {
         this.lastMoveTransformation = quantumTransformation;
       }
     }
-    if (vismods) {
+    if (__privateGet(this, _pendingStickeringUpdate) || vismods) {
       this.filler.makeGroups(this.fixedGeo);
     }
-    if (colormods) {
+    if (__privateGet(this, _pendingStickeringUpdate) || colormods) {
       if (this.textured) {
         this.fixedGeo.getAttribute("uv").updateRange = {
           offset: 0,
           count: 6 * this.foundationBound
         };
         this.fixedGeo.getAttribute("uv").needsUpdate = true;
-      } else {
+      }
+      if (__privateGet(this, _pendingStickeringUpdate) || !this.textured) {
         this.fixedGeo.getAttribute("color").updateRange = {
           offset: 0,
           count: 9 * this.foundationBound
@@ -1297,6 +1297,7 @@ var PG3D = class extends Object3D2 {
       }
     }
     this.scheduleRenderCallback();
+    __privateSet(this, _pendingStickeringUpdate, false);
   }
   ease(fraction) {
     return smootherStep(fraction);
@@ -1387,8 +1388,6 @@ var PG3D = class extends Object3D2 {
   experimentalUpdateTexture(enabled, stickerTexture, hintTexture) {
     if (!stickerTexture) {
       enabled = false;
-    } else if (!hintTexture) {
-      hintTexture = stickerTexture;
     }
     if (enabled && !this.filler.uvs) {
       this.adduvs();
@@ -1422,6 +1421,9 @@ var PG3D = class extends Object3D2 {
     } else {
       this.hintMaterial = basicStickerMaterial;
     }
+    if (enabled) {
+      this.showHintFacelets(hintTexture !== null);
+    }
     this.updateMaterialArrays();
     __privateSet(this, _pendingStickeringUpdate, true);
     if (this.lastPos) {
@@ -1494,4 +1496,4 @@ export {
   cube3DShim,
   pg3dShim
 };
-//# sourceMappingURL=3d-dynamic-AKACURPM.js.map
+//# sourceMappingURL=3d-dynamic-DKWMBHRS.js.map