Skip to content

MinecraftCapes/minecraft-skin-viewer

Repository files navigation

Minecraft Skin Viewer

CI Status NPM Package

Built using THREE.js for the MinecraftCapes website.

Demo - https://minecraft-skin-viewer.james090500.workers.dev

Example

Creating an instance

import MinecraftSkinViewer from '../src/main.js'

this.minecraftSkinViewer = new MinecraftSkinViewer({
    canvas: HTMLCanvasElement //The canvas
    skin?: string //Skin (Optional)
    model?: string | "classic" | "slim" | null //Model (Optional)
    cape?: string //Cape (Optional)
    ears?: string //Ears (Optional)
    dinnerbone?: boolean //Dinnerbone (upside down) (Optional)
    glint?: boolean // Glint (cape enchantment glint) (Optional
})

Loading a skin, cape or ears

You can load a skin, cape or ears using a relative path, url or even base64. You can change the model by providing "classic", "slim" or null for a best guess

this.minecraftSkinViewer.loadSkin('/skins/skin.png', 'classic')
this.minecraftSkinViewer.loadCape('https://api.minecraftcapes.net/profile/ba4161c03a42496c8ae07d13372f3371/cape')
this.minecraftSkinViewer.loadEars('iVBORw0KGgoAAAANSUhEUgAAAA4AAAAHCAYAAAA4R3wZAAAACXBIWXMAAA7EAAAOxAGVKw4bAAAAXklEQVQYlWP8//8/Q93Z7P8MDAwM7x5/YBCSFWCAAWQ+MrvJeCojY+2ZrP8MSABdMzqAybMgC+CyCRtgwifJwMCA1fZ3jz9ANOKSxGcYEy4FQrICeDWzwGzDZis+OQC7EjD/iYogOAAAAABJRU5ErkJggg==')

Clearing a skin, cape, ears

You just set the value to null. However, skin can't be null so it randomly picks Steve or Adam to display

this.minecraftSkinViewer.loadSkin(null) //Will load a random Steve or Alex skin
this.minecraftSkinViewer.loadCape(null) //Will remove the cape/elytra texture
this.minecraftSkinViewer.loadEars(null) //Will remove the ears

Customisation

You can flip the user, enable the elytra or give their cape a glint with the below

this.minecraftSkinViewer.setElytra(true)
this.minecraftSkinViewer.setDinnerbone(true)
this.minecraftSkinViewer.setGlint(true)

About

A 3D Minecraft Skin/Cape/Ears viewer build with Three.JS

Resources

License

Stars

6 stars

Watchers

3 watching

Forks

Contributors