miijs 2.4.0 → 2.4.2

package/.github/workflows/npm-publish-github-packages.yml

@@ -0,0 +1,36 @@
+# This workflow will run tests using node and then publish a package to GitHub Packages when a release is created
+# For more information see: https://docs.github.com/en/actions/publishing-packages/publishing-nodejs-packages
+
+name: Node.js Package
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+      - run: npm ci
+      - run: npm test
+
+  publish-gpr:
+    needs: build
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          registry-url: https://npm.pkg.github.com/
+      - run: npm ci
+      - run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.GITHUB_TOKEN}}

package/README.md

@@ -47,7 +47,7 @@ MiiJS is a complete and comprehensive Mii library for reading, converting, modif
 - **`miiHeightToMeasurements(miiHeight)`** - Converts Mii height value (0-127) to real-world feet and inches. Returns `{feet, inches, totalInches, centimeters}`.
 - **`inchesToMiiHeight(totalInches)`** - Converts real-world height in inches to Mii height value (0-127).
 - **`centimetersToMiiHeight(totalCentimeters)`** - Converts real-world height in centimeters to Mii height value (0-127).
-- **`miiWeightToRealWeight(miiWeight)`** - Converts Mii weight value (0-127) to real-world weight values. Returns `{pounds, kilograms}`.
+- **`miiHeightWeightToRealWeight(miiWeight)`** - Converts Mii weight value (0-127) to real-world weight values. Returns `{pounds, kilograms}`.
 - **`imperialHeightWeightToMiiWeight(heightInches, weightLbs)`** - Converts real-world imperial measurements to Mii weight values.
 - **`metricHeightWeightToMiiWeight(heightCentimeters, weightKilograms)`** - Converts real-world metric measurements to Mii weight values.
 
@@ -360,4 +360,4 @@ You can find FFLResHigh using a Wii U with an FTP program installed at `sys/titl
  - **[kazuki-4ys' MiiInfoEditorCTR](https://github.com/kazuki-4ys/kazuki-4ys.github.io/tree/master/web_apps/MiiInfoEditorCTR)** - I repurposed how to decrypt and reencrypt the QR codes from here, including repurposing the asmCrypto.js file in its entirety with very small modifications (it has since been stripped down to only include the functions this library uses). I believe I also modified the code for rendering the Mii using Nintendo's Mii Studio from here as well, though I do not remember for certain.
  - **[ariankordi's FFL.js](https://github.com/ariankordi/FFL.js/)** - Rendering Miis locally would not be possible without this library. Instructions for finding FFLResHigh are also learned from [ariankordi's FFL-Testing repository](https://github.com/ariankordi/FFL-Testing).
  - **[Models Resource](https://models.spriters-resource.com/3ds/systembios/asset/306260/)** - For the bodies used in Mii rendering
- - **[socram8888's Amiitools](https://github.com/socram8888/amiitool)** - I _think_, for the code reverse engineered to help with aspects of Amiibo dump processing. I went through so many iterations in research and coding, there may be other credits due as well but I _think_ this was the only repo actually used for the reverse engineering in the final working code.
+ - **[socram8888's Amiitools](https://github.com/socram8888/amiitool)** - I _think_, for the code reverse engineered to help with aspects of Amiibo dump processing. I went through so many iterations in research and coding, there may be other credits due as well but I _think_ this was the only repo actually used for the reverse engineering in the final working code.

package/index.js

@@ -12,7 +12,6 @@ const httpsLib = require('https');
 const asmCrypto = require("./asmCrypto.js");
 const path = require("path");
 const createGL = require('gl');
-const typeCheat = [1, 2, 3, 1, 2, 3, 1, 2, 3, 1, 2, 3];
 const {
     createCharModel, initCharModelTextures,
     initializeFFL, exitFFL, parseHexOrB64ToUint8Array,
@@ -20,6 +19,7 @@ const {
 } = require("./fflWrapper.js");
 const ModuleFFL = require("ffl.js/examples/ffl-emscripten-single-file.js");
 const FFLShaderMaterial = require("ffl.js/FFLShaderMaterial.js");
+const typeCheat = [1, 2, 3, 1, 2, 3, 1, 2, 3, 1, 2, 3];
 
 // Typedefs for intellisence
 /** @typedef {import('./types').WiiMii} WiiMii */
@@ -1570,6 +1570,12 @@ function makeChild(parent0, parent1, options) {
     if(parent0.console.toLowerCase()==="wii") parent0=convertMii(parent0,"3DS");
     if(parent1.console.toLowerCase()==="wii") parent1=convertMii(parent1,"3DS");
 
+    if(parent0.general.gender!==0){
+        let tempHolder=structuredClone(parent0);
+        parent0=structuredClone(parent1);
+        parent1=structuredClone(tempHolder);
+    }
+
     var randomBytes = [];
     for (var i = 0; i < 8; i++) {
         //randomBytes[1] is never used, kept here purely for an interesting detail from research
@@ -1601,7 +1607,6 @@ function makeChild(parent0, parent1, options) {
     child.meta.name = options?.hasOwnProperty("name")? options.name : childGenTables.names[child.general.gender][Math.floor(Math.random() * childGenTables.names[child.general.gender].length)];
 
     var matchingParent = parent0.general.gender === gender ? parent0 : parent1;
-    var mainParentFlag = (matchingParent === parent0) ? 0 : 1;
 
     //Skin color mixing. Intuitively you'd think they'd order them by similarity and pick an average, but no they have an entire table of what skin colors product what child skin color
     var validValues = childGenTables.skinColorMixing[Math.min(parent0.face.color, parent1.face.color)][Math.max(parent0.face.color, parent1.face.color)].filter(v => v !== -1);
@@ -1618,8 +1623,6 @@ function makeChild(parent0, parent1, options) {
     child.eyebrows.page = matchingParent.eyebrows.page;
     child.eyebrows.type = matchingParent.eyebrows.type;
 
-    child.face.color = [7, 7, 6, 7][Math.min(child.face.color, 3)];
-
     child.eyebrows.color = child.hair.color;
 
     child.nose.page = randomBytes[5] === 0 ? parent0.nose.page : parent1.nose.page;
@@ -1683,7 +1686,7 @@ function makeChild(parent0, parent1, options) {
         delete child.stages[iStage].stages;//Because we're just cloning the baseline object repeatedly to make the stages a little bit cleaner, we need to clear this on subsequent clones
     }
 
-    //If this looks odd, it is setup in a specific way to mimic the research I did into hair generation as 1:1 as possible
+    //Basically there's a random chance for a hairstyle to not advance throughout the years, so it's possible to end up with a hairstyle from a younger stage. This is slightly more likely for boys than girls.
     let ageGroup = 0;
     for (let iHairStage = 0; iHairStage < 4; iHairStage++) {
         const subgroup = childGenTables.hairStyleGroups[hairGroupIndex][ageGroup];
@@ -1713,25 +1716,8 @@ function makeChild(parent0, parent1, options) {
                 child.stages[5].hair.type = hairType;
             break;
         }
-        if (mainParentFlag === 0) {
-            if (iHairStage === 0) {
-                ageGroup = Math.min(ageGroup + 1, 3);
-            }
-            else {
-                if (Math.floor(Math.random() * 3) !== 0) {
-                    ageGroup = Math.min(ageGroup + 1, 3);
-                }
-            }
-        }
-        else {
-            if (iHairStage === 0) {
-                ageGroup = Math.min(ageGroup + 1, 3);
-            }
-            else {
-                if (Math.floor(Math.random() * 4) !== 0) {
-                    ageGroup = Math.min(ageGroup + 1, 3);
-                }
-            }
+        if (iHairStage === 0 || Math.floor(Math.random() * (child.stages[0].general.gender === 0 ? 3 : 4)) !== 0) {//For each stage of life there is a 33% chance for boys, and a 25% chance for girls, of staying on the same hairstyle as they had already. However, they are guaranteed to never have the same hairstyle stage as their newborn stage.
+            ageGroup = Math.min(ageGroup + 1, 3);
         }
     }
     return child.stages;
@@ -1895,7 +1881,6 @@ function miiWeightToRealWeight(heightInches, miiWeight) {
 
     This is approximate, not guaranteed accurate nor intended to be taken that way. This is for entertainment value only.
     */
-    if (!heightInches || heightInches < 0) throw new Error("heightInches must be >= 0");
     const H = miiHeightToMeasurements(heightInches).totalInches;
     const BMI = bmiFromWeightSlider(miiWeight);
     return {
@@ -1904,8 +1889,6 @@ function miiWeightToRealWeight(heightInches, miiWeight) {
     };
 }
 function imperialHeightWeightToMiiWeight(heightInches, weightLbs) {
-    if (!heightInches || heightInches < 0) throw new Error("heightInches must be >= 0");
-
     const H = miiHeightToMeasurements(heightInches).totalInches;
     const BMI = weightLbs * 703 / (H * H);
 
@@ -1919,8 +1902,6 @@ function imperialHeightWeightToMiiWeight(heightInches, weightLbs) {
 function metricHeightWeightToMiiWeight(heightCentimeters, weightKilograms) {
     const heightInches = Math.round(heightCentimeters / 2.54);
     const weightLbs = Math.round(weightKilograms / 0.4535924);
-    if (!heightInches || heightInches < 0) throw new Error("heightCentimeters must be >= 0");
-
     const H = miiHeightToMeasurements(heightInches).totalInches;
     const BMI = weightLbs * 703 / (H * H);