Ubujira
/
skinview3d
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

update readme

This commit is contained in:
yushijinhun 2017-10-01 20:17:34 +08:00
parent 28893c847e
commit 3df2707323
No known key found for this signature in database
GPG Key ID: 5BC167F73EA558E4
1 changed files with 47 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
README.md
View File

@ -1,4 +1,9 @@
# skinview3d
skinview3d
========
[![Latest NPM release][npm-badge]][npm-badge-url]
[![License][license-badge]][license-badge-url]
Three.js powered Minecraft skin viewer.
# Features
@ -7,10 +12,49 @@ Three.js powered Minecraft skin viewer.
* Capes
* Slim arms
# Usage
```html
<div id="skin_container"></div>
<script>
let skinViewer = new skinview3d.SkinViewer({
domElement: document.getElementById("skin_container"),
slim: true,
width: 600,
height: 600,
skinUrl: "img/skin.png",
capeUrl: "img/cape.png",
animation: skinview3d.WalkAnimation
});
// change the skin and cape
// skinViewer.skinUrl = "img/skin.png";
// skinViewer.capeUrl = "img/cape.png";
// change the width and height
// skinViewer.width = 300;
// skinViewer.height = 400;
// enable the mouse control feature
let control = new skinview3d.SkinControl(skinViewer);
// pause the animation
// skinViewer.animationPaused = true;
// change the animation speed
// skinViewer.animationSpeed = 8;
// disable the 'right click to play/pause' feature
// control.enableAnimationControl = false;
</script>
```
# Build
`npm run build` Concatenation only.
`npm run build-babel` Concatenate and compile using Babel (es2015).
# License
The repository is licensed under GPL-3.0 License.
[npm-badge]: https://img.shields.io/npm/v/skinview3d.svg
[npm-badge-url]: https://www.npmjs.com/package/skinview3d
[license-badge]: https://img.shields.io/npm/l/skinview3d.svg
[license-badge-url]: ./LICENSE