Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/takahirox/a-mmd
A-Frame MMD component
https://github.com/takahirox/a-mmd
a-frame aframe aframevr javascript mmd three-js threejs vr webvr
Last synced: 28 days ago
JSON representation
A-Frame MMD component
- Host: GitHub
- URL: https://github.com/takahirox/a-mmd
- Owner: takahirox
- License: mit
- Created: 2016-11-11T21:41:02.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2017-11-01T08:53:32.000Z (about 7 years ago)
- Last Synced: 2024-09-29T05:21:52.644Z (about 1 month ago)
- Topics: a-frame, aframe, aframevr, javascript, mmd, three-js, threejs, vr, webvr
- Language: JavaScript
- Homepage: https://cdn.rawgit.com/takahirox/a-mmd/v1.0.3/index.html
- Size: 2.18 MB
- Stars: 84
- Watchers: 7
- Forks: 10
- Open Issues: 4
-
Metadata Files:
- Readme: Readme.md
- License: LICENSE
Awesome Lists containing this project
README
# A-Frame MMD component
a-mmd is an A-Frame MMD component which enables MMD models to dance and sing.
## Demo
[Demo Dance](https://cdn.rawgit.com/takahirox/a-mmd/v1.0.3/index.html)
[Demo Posing](https://cdn.rawgit.com/takahirox/a-mmd/v1.0.3/index2.html)
# Dependencies
## Ammo.js
You need to load ammo.js in a page where a-mmd works
https://github.com/kripken/ammo.js/
## A-Frame Outline effect component
To draw outline, use A-Frame Outline effect component.
https://github.com/takahirox/aframe-outline
## Properties
### mmd
| Properties | type | Default Value | Description |
| -------------- | ------- | ------------- | ----------- |
| audio | string | '' | Audio file path. |
| autoplay | boolean | true | Automatically start audio and dance when they're ready. |
| volume | number | 1.0 | Audio volume. |
| audioDelayTime | number | 0.0 | How long audio delays to start to play since model starts to dance. |
| afterglow | number | 0.0 | How long model keeps the last motion since dance/audio ends. |
### mmd-model
| Properties | type | Default Value | Description |
| ---------- | ------- | ------------- | ----------- |
| model | string | '' | MMD model file path. |
| vpd | string | '' | MMD pose file path. |
| vmd | string | '' | MMD dance file path. You can set multiple vmd files separated by ',' |
| physics | boolean | false | If turn on physics. |
| blink | boolean | false | If model blinks one's eyes. |
## Browser
### How to use
```html
```
## NPM
### How to install
```
$ npm install a-mmd
```
### How to build
```
$ npm install
$ npm run all
```
### How to load
```
require('./libs/ammo.js');
require('aframe');
require('a-mmd');
```
## Copyright
You are allowed to use Crypton's Vocaloid(Hatsune Miku, Kagamine Rin, and so on)
stuffs (MMD models, songs, and so on) only if you follow the guideline set by
Crypton Future Media, INC. for the usage of its characters.
For detail, see http://piapro.net/en_for_creators.html
## MMD assets license
The license of MMD assets used in index.html
https://github.com/mrdoob/three.js/tree/dev/examples/models/mmd#readme