Reference Overview

This section provides detailed explanations of the features offered by babylon-mmd.

The core functionality of babylon-mmd is to load PMX, PMD, VMD, and VPD files and seamlessly integrate MMD models into Babylon.js scenes.

babylon-mmd offers various options to accurately reproduce the behavior of MMD (MikuMikuDance) while ensuring compatibility with Babylon.js rendering pipelines.

You can selectively use features that match your specific use case and create optimal configurations for your Babylon.js scenes. This requires understanding both how MMD works and how babylon-mmd reproduces these mechanics, which this section covers in detail.

info

If you want to know the basic usage of loading MMD models and playing animations, please refer to the Getting Started section. This section provides guidance on the basic usage and setup of babylon-mmd.

The reference documentation includes the following topics:

Overview

This section explains the components that make up babylon-mmd and their relationships.

Understanding MMD Behavior

These sections provide information needed to understand the asset structure and behavior of MMD. They also help build a basic understanding of how babylon-mmd reproduces MMD's behavior.

• Introduction to PMX and PMD - Provides information needed to understand the structure and behavior of PMX and PMD files.
• Introduction to VMD and VPD - Provides information needed to understand the structure and behavior of VMD and VPD files.

Loader

These sections explain how to load MMD models and animation data.

• MMD Model Loader (PmxLoader, PmdLoader) - Describes the components used to load MMD model files (PMX, PMD).

  • Fix BMP Texture Loader - Explains the component for correctly loading MMD models with BMP textures.
  • SDEF Support - Explains the component for correctly loading MMD models with Spherical Deformation (SDEF).
  • MMD StandardMaterial - Describes the standard material used for MMD models.
  • Material Builder - Explains how to assign materials to MMD models and discusses how to reproduce MMD's rendering methods.
    • Build Your Own MMD Material Builder - Explains how to customize material assignment for MMD models.
  • The Babylon PMX format - Describes the BPMX file format, a variant of PMX files provided by babylon-mmd.
    • Convert PMX to BPMX format - Explains how to convert PMX files to BPMX format.
    • BPMX Loader - Explains how to load BPMX files.

• Mmd Animation Loader (VmdLoader, VpdLoader) - Describes the components used to load MMD animation files (VMD, VPD).

  • The Babylon VMD format - Describes the BVMD file format, a variant of VMD files provided by babylon-mmd.
    • Convert VMD to BVMD format - Explains how to convert VMD files to BVMD format.
    • BVMD Loader - Explains how to load BVMD files.

Runtime

These sections describe the runtime components needed to run MMD models and animations.

• MMD Camera - Explains how to set up and use an MMD camera.
• MMD Runtime - Describes the runtime environment for running MMD models and animations.
• MMD WebAssembly Runtime - Explains how to run MMD animations using WebAssembly.
• Enable Material Morphing - Explains how to enable material morphing in MMD models.
• Apply Physics To MMD Models - Explains how to set up physics for MMD models.
• Bullet Physics - Explains how to control the Bullet Physics world.
• Animation - Explains how to set up and control animations for MMD models.
  • MMD Animation - Explains how to set up and use MMD animations.
  • Use Babylon.js Animation Runtime - Explains how to use the Babylon.js animation runtime.
  • MMD Player Control - Explains how to control MMD animations using a GUI similar to a video player.
  • Animation Blending - Explains how to blend multiple animations together.
• Audio Player - Explains how to set up an audio player synchronized with animations.
• Apply MMD Animation on Non-MMD Model - Explains how to apply MMD animations to non-MMD models.
• Use MMD Model Without Runtime - Explains how to use MMD models without a runtime.