# @pixiv/three-vrm-materials-mtoon

> MToon (toon material) module for @pixiv/three-vrm

Latest version **3.5.5** (published 2026-07-09) · MIT license · 0 weekly downloads

## Install

```sh
npm install @pixiv/three-vrm-materials-mtoon
pnpm add @pixiv/three-vrm-materials-mtoon
yarn add @pixiv/three-vrm-materials-mtoon
bun add @pixiv/three-vrm-materials-mtoon
```

## Health

**Score 65/100 (B)** — status: active.

Positive: has types; esm support; no vulnerabilities; has provenance; high maintenance score.

Warnings: low downloads.

## Facts

| | |
|---|---|
| Version | 3.5.5 |
| Published | 2026-07-09 |
| First published | 2021-08-10 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 2 |
| Unpacked size | 664.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 2292 |
| Author | pixiv |
| Maintainers | jessidhia, geta6, fms-cat, pixiv-npm, keshigomu, yue4u |

## Links

- npm: https://www.npmjs.com/package/@pixiv/three-vrm-materials-mtoon
- Repository: https://github.com/pixiv/three-vrm
- Homepage: https://github.com/pixiv/three-vrm#readme
- Issues: https://github.com/pixiv/three-vrm/issues
- npm.io page: https://npm.io/package/@pixiv/three-vrm-materials-mtoon

## Dependencies (2)

- [@pixiv/types-vrm-0.0](https://npm.io/package/@pixiv/types-vrm-0.0.md) 3.5.5
- [@pixiv/types-vrmc-materials-mtoon-1.0](https://npm.io/package/@pixiv/types-vrmc-materials-mtoon-1.0.md) 3.5.5

## Recent versions

- 3.5.5 (latest) — 2026-07-09
- 3.6.0-beta.0 (next) — 2026-09-25
- 3.4.3-alpha.0 (alpha) — 2025-10-02
- 3.5.4 — 2026-06-15
- 3.5.3 — 2026-05-18
- 3.5.2 — 2026-04-16
- 3.5.1 — 2026-03-12
- 3.5.0 — 2026-02-26
- 3.4.5 — 2026-01-13
- 3.4.4 — 2025-10-29
- 3.4.3 — 2025-10-14
- 3.4.2 — 2025-07-07
- 3.4.1 — 2025-05-27
- 3.4.0 — 2025-04-10
- 3.3.7 — 2025-04-08
- … 72 more at https://npm.io/package/@pixiv/three-vrm-materials-mtoon/versions

## README

# @pixiv/three-vrm-materials-mtoon

MToon (toon material) module for @pixiv/three-vrm

[GitHub Repository](https://github.com/pixiv/three-vrm/tree/dev/packages/three-vrm-materials-mtoon)

[Examples](https://pixiv.github.io/three-vrm/packages/three-vrm-materials-mtoon/examples)

[API Reference](https://pixiv.github.io/three-vrm/docs/modules/three-vrm-materials-mtoon)

## WebGPU Support

Starting from v3, we provide [WebGPURenderer](https://github.com/mrdoob/three.js/blob/master/examples/jsm/renderers/webgpu/WebGPURenderer.js) compatibility.
To use MToon with WebGPURenderer, specify the WebGPU-compatible `MToonNodeMaterial` for the `materialType` option of `MToonMaterialLoaderPlugin`.

`MToonNodeMaterial` only supports Three.js r167 or later.
The NodeMaterial system of Three.js is still under development, so we may break compatibility with older versions of Three.js more frequently than other parts of three-vrm.

```js
import { GLTFLoader } from 'three/addons/loaders/GLTFLoader.js';
import { MToonMaterialLoaderPlugin } from '@pixiv/three-vrm-materials-mtoon';
import { MToonNodeMaterial } from '@pixiv/three-vrm-materials-mtoon/nodes';

// ... Setup renderer, camera, scene ...

// Create a GLTFLoader
const loader = new GLTFLoader();

// Register a MToonMaterialLoaderPlugin with MToonNodeMaterial
loader.register((parser) => {

  // create a WebGPU compatible MToonMaterialLoaderPlugin
  return new MToonMaterialLoaderPlugin(parser, {

    // set the material type to MToonNodeMaterial
    materialType: MToonNodeMaterial,

  });

});

// ... Load the VRM and perform the render loop ...
```

See the example for the complete code: https://github.com/pixiv/three-vrm/blob/release/packages/three-vrm-materials-mtoon/examples/webgpu-loader-plugin.html

---
_Source: https://npm.io/package/@pixiv/three-vrm-materials-mtoon · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
