skinview3d/README.md

45 lines
1.4 KiB
Markdown

# skinpreview3d.js
A Three.js powered Minecraft skin viewer.
The code was originally created by [Kent Rasmussen](https://github.com/earthiverse). You can find out more about his project [here](https://github.com/earthiverse/3D-Minecraft-Skin-Viewer).
# Features
* 1.8 Skins
* HD Skins
* Capes
* Slim arms
# Dependencies
* [Three.js](https://github.com/mrdoob/three.js/)
* [jQuery](https://jquery.com/) (Optional)
# Usage
HTML
```html
<div id="skin_container"></div>
```
JS
```js
$(() => {
$("#skin_container").skinPreview3d({
skinUrl: 'img/hatsune_miku.png',
capeUrl: 'img/mojang_cape.png',
slim: true,
width: 600,
height: 600
});
});
```
# Demos
* [Native javascript](http://hacksore.github.io/skinpreview3d.js/demo_purejs.html)
* [jQuery](http://hacksore.github.io/skinpreview3d.js/demo_jquery.html)
# License
* `/img/mojang_cape.png` Copyright Mojang AB. [Link](https://minecraft.gamepedia.com/File:MojangCape2016.png)
* `/img/hatsune_miku.png` Copyright xilefian. [Link](http://www.minecraftforum.net/forums/mapping-and-modding/skins/2646900-hatsune-miku-skin-1-9-transparency-layers)
* `/img/1_8_texturemap_redux.png` Copyright Mojang AB. [Link](https://minecraft.gamepedia.com/File:1_8_texturemap_redux.png)
* `/img/steve_old.png` Copyright Mojang AB. [Link](https://minecraft.gamepedia.com/File:Char.png)
Other parts of the repository are licensed under GPLv3 License.