A JavaScript library used to interact with Mii data from the Wii U and 3DS

• Mii JS
  • API
    • new Mii(buffer);
      • Usage
    • Updating Mii data
      • Usage
      • Properties
      • Notes and special cases
      • Clothes colors
    • mii.encode();
      • Usage
    • mii.encodeStudio();
      • Usage
    • mii.studioUrl(renderOptions);
      • Usage
    • mii.studioAssetUrlBody();
      • Usage
    • mii.studioAssetUrlHead();
      • Usage
    • mii.studioAssetUrlFace();
      • Usage
    • mii.studioAssetUrlEye();
      • Usage
    • mii.studioAssetUrlEyebrow();
      • Usage
    • mii.studioAssetUrlNose();
      • Usage
    • mii.studioAssetUrlMouth();
      • Usage
    • mii.studioAssetUrlHair();
      • Usage
    • mii.studioAssetUrlBeard();
      • Usage
    • mii.studioAssetUrlMustache();
      • Usage
    • mii.studioAssetUrlGlasses();
      • Usage
    • mii.studioAssetUrlMole();
      • Usage
    • mii.decode();
    • mii.validate();
    • mii.studioAssetUrl(assetPath);
    • mii.calculateCRC();
  • Render options
    • type
    • expression
    • width
    • bgColor
    • clothesColor
    • cameraXRotate
    • cameraYRotate
    • cameraZRotate
    • characterXRotate
    • characterYRotate
    • characterZRotate
    • lightXDirection
    • lightYDirection
    • lightZDirection
    • lightDirectionMode
    • instanceCount
    • instanceRotationMode
  • Examples
    • Error on invalid Mii data
    • Encode as Mii Studio Mii
    • Get Mii Studio render URL (default)
    • Get Mii Studio render URL (render options)

Instantiate a new Mii instance. Takes in a Buffer of Mii data

const miiData = 'AwEAMLrDTIqIpLZhlH8Ps6TA4eK42QAAAFAOMHPgSQBtAG8AcgBhAHPgDzAAAGsrAgA5AQJoRBgm\r\nNEYUgRIWaA0AACmGAUhQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAG7s';
const mii = new Mii(Buffer.from(miiData, 'base64'));
// ...

All Mii data is stored as properties on the Mii class. To update a Mii's data simply assign it a new value in the respective property.

mii.height = 10;
mii.wrinklesType = 1;
// etc

There are special cases where sometimes some data affects the validity of other data in the Mii. these cases will be noted here

• If mii.normalMii is set to false (Mii is special), then mii.deviceOrigin determines the minimum device type the Mii QR code can be scanned on. For example, a Mii with mii.normalMii to to false and mii.deviceOrigin set to 3 can be scanned on a 3DS, WiiU and Switch. But if the mii.deviceOrigin is set to 4, the Mii cannot be scanned on a 3DS. Setting this value to 4 essentially locks the Mii to the WiiU though this is not intended usage
• If mii.nonUserMii is set to true then mii.creationTime must be set to 0 and mii.normalMii, mii.dsMii, and mii.isValid must all be set to false
• If mii.normalMii is set to false (Mii is special), then mii.disableSharing must be set to true (all special Mii's have sharing disabled)
• According to HEYimHeroic if mii.dsMii is true, then mii.isValid must be false. However in my testing, all Mii's created on the Wii U have both mii.dsMii and mii.isValid set to true. Therefore this check is not performed here, and this case is being looked into
• It appears that if a Mii has mii.deviceOrigin set to 1 (Wii), then mii.isValid is set to false. This has not been confirmed, however

• 0 = red
• 1 = orange
• 2 = yellow
• 3 = light green
• 4 = dark green
• 5 = blue
• 6 = light blue
• 7 = pink
• 8 = purple
• 9 = brown
• 10 = white
• 11 = black

Encodes a Mii's data as a Wii U/3DS format Mii. Returns a Buffer

const encoded = mii.encode();
console.log(encoded.toString('base64'));

Encodes a Mii's data as a Mii Studio format Mii. Returns a Buffer

const encoded = mii.encodeStudio();
console.log(encoded.toString('hex'));

Encodes a Mii's data as a Mii Studio format Mii and returns it's render URL. See Render options for more information

const url = mii.studioUrl({
	width: 512,
	type: 'all_body'
});
console.log(url);

Returns the Mii's individual body asset URL as used on Mii Studio

console.log(mii.studioAssetUrlBody());

Returns the Mii's individual head asset URL as used on Mii Studio

console.log(mii.studioAssetUrlHead());

Alias of mii.studioAssetUrlHead();

console.log(mii.studioAssetUrlFace());

Returns the Mii's individual Eye asset URL as used on Mii Studio

console.log(mii.studioAssetUrlEye());

Returns the Mii's individual Eyebrow asset URL as used on Mii Studio

console.log(mii.studioAssetUrlEyebrow());

Returns the Mii's individual Nose asset URL as used on Mii Studio

console.log(mii.studioAssetUrlNose());

Returns the Mii's individual Mouth asset URL as used on Mii Studio

console.log(mii.studioAssetUrlMouth());

Returns the Mii's individual Hair asset URL as used on Mii Studio

console.log(mii.studioAssetUrlHair());

Returns the Mii's individual Beard asset URL as used on Mii Studio

console.log(mii.studioAssetUrlBeard());

Returns the Mii's individual Mustache asset URL as used on Mii Studio

console.log(mii.studioAssetUrlMustache());

Returns the Mii's individual Glasses asset URL as used on Mii Studio

console.log(mii.studioAssetUrlGlasses());

Returns the Mii's individual Mole asset URL as used on Mii Studio

console.log(mii.studioAssetUrlMole());

Decodes a Mii's data and populates it's fields. Used internally, does not need to be called manually

Validates a Mii's data and throws an error if invalid data is found. Used internally, does not need to be called manually

Calculates the Mii's individual asset URL based on the provided asset path. Used internally, does not need to be called manually

Calculates a Mii's CRC checksum. Used internally, does not need to be called manually

Mii Studio accepts various render options. These options are passed as an object to mii.studioUrl(renderOptions). If a value is not passed or is deemed invalid, the library will instead use a default value

Render type

Default: face

Mii expression

Default: normal

Image width (height cannot be changed)

Default: 96

Background color. Must be uppercase HEX encoded RGBA

Default: FFFFFF00

Color of the Mii's clothes. Overrides the color in the Mii data

Default: default

Rotate the camera in the X axis

Default: 0

Rotate the camera in the Y axis

Default: 0

Rotate the camera in the Z axis

Default: 0

Rotate the character model in the X axis

Default: 0

Rotate the character model in the Y axis

Default: 0

Rotate the character model in the Z axis

Default: 0

Rotate the light source position/direction in the X axis

Default: 0

Rotate the light source position/direction in the Y axis

Default: 0

Rotate the light source position/direction in the Z axis

Default: 0

Changes the light direction mode

When this is set to the default of none, the light direction parameters are not sent at all.

Default: none

How many renders are returned.

After the first render the following renders are rotated depending on the number of instances from 0 degrees to 180 degrees

Default: 1

Changes the rotation mode for each render following the first

Default: model

mii.hairColor = 9999;

const encoded = mii.encode(); // AssertionError [ERR_ASSERTION]: Invalid Mii hair color. Got 9999, expected 0-7

const encoded = mii.encodeStudio();

console.log(encoded).toString('base64');

const studioUrl = mii.studioUrl();

console.log(studioUrl);

const studioUrl = mii.studioUrl({
	width: 512,
	bgColor: '131733FF'
});

console.log(studioUrl);