skinview3d/README.md

46 lines
1.3 KiB
Markdown
Raw Normal View History

2015-09-29 18:52:18 +02:00
# skinpreview3d.js
2017-09-02 14:39:01 +02:00
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).
2016-01-10 18:28:54 +01:00
# Features
* 1.8 Skins
2017-09-02 14:39:01 +02:00
* HD Skins
2016-01-10 18:28:54 +01:00
* Capes
2017-08-30 14:26:04 +02:00
* Slim arms
2016-01-10 18:28:54 +01:00
# Dependencies
* [Three.js](https://github.com/mrdoob/three.js/)
2017-09-02 14:39:01 +02:00
* [jQuery](https://jquery.com/) (Optional)
2017-09-02 18:22:34 +02:00
# Demos
[jQuery](http://hacksore.github.io/skinpreview3d.js/demo_jquery.html)
[Native javascript](http://hacksore.github.io/skinpreview3d.js/demo_purejs.html)
# Usage
HTML
2016-01-10 18:28:54 +01:00
```html
2017-08-29 17:04:08 +02:00
<div id="skin_container"></div>
```
JS
2016-01-10 18:28:54 +01:00
```js
2017-08-29 17:04:08 +02:00
$(() => {
2017-09-02 15:14:31 +02:00
$("#skin_container").skinPreview3d({
2017-08-30 14:26:04 +02:00
skinUrl: 'img/hatsune_miku.png',
2017-09-02 15:14:31 +02:00
capeUrl: 'img/mojang_cape.png',
2017-08-30 14:26:04 +02:00
slim: true,
2017-08-29 17:04:08 +02:00
width: 600,
height: 600
});
});
```
2017-09-02 14:39:01 +02:00
See `example_jquery.html` and `example_purejs.html` for more examples.
2017-09-01 14:45:48 +02:00
# 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)
Other parts of the repository are licensed under GPLv3 License.