diff --git a/README.md b/README.md index bc37d80..5624cf2 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,7 @@ Three.js powered Minecraft skin viewer. * 1.8 Skins * HD Skins * Capes +* Ears * Elytras * Slim Arms * Automatic model detection (Slim / Default) @@ -104,5 +105,34 @@ skinViewer.globalLight.intensity = 0.1; Setting `globalLight.intensity` to `1.0` and `cameraLight.intensity` to `0.0` will completely disable shadows. +## Ears +skinview3d supports two types of ear texture: +* `standalone`: 14x7 image that contains the ear ([example](https://github.com/bs-community/skinview3d/blob/master/examples/img/ears.png)) +* `skin`: Skin texture that contains the ear (e.g. [deadmau5's skin](https://minecraft.fandom.com/wiki/Easter_eggs#Deadmau5.27s_ears)) + +Usage: +```js +// You can specify ears in the constructor: +new skinview3d.SkinViewer({ + skin: "img/deadmau5.png", + + // Use ears drawn on the current skin (img/deadmau5.png) + ears: "current-skin", + + // Or use ears from other textures + ears: { + textureType: "standalone", // "standalone" or "skin" + source: "img/ears.png" + } +}); + +// Show ears when loading skins: +skinViewer.loadSkin("img/deadmau5.png", { ears: true }); + +// Use ears from other textures: +skinViewer.loadEars("img/ears.png", { textureType: "standalone" }); +skinViewer.loadEars("img/deadmau5.png", { textureType: "skin" }); +``` + # Build `npm run build` diff --git a/examples/img/deadmau5.png b/examples/img/deadmau5.png new file mode 100644 index 0000000..005cc1a Binary files /dev/null and b/examples/img/deadmau5.png differ diff --git a/examples/img/ears.png b/examples/img/ears.png new file mode 100644 index 0000000..10c101f Binary files /dev/null and b/examples/img/ears.png differ diff --git a/examples/index.html b/examples/index.html index cb12ab0..4a87c8f 100644 --- a/examples/index.html +++ b/examples/index.html @@ -215,6 +215,7 @@