# three-vrm-utils

React hooks and utilities for working with [VRM](https://vrm.dev/en/) avatars in [React Three Fiber](https://github.com/pmndrs/react-three-fiber). Extension support for [@pixiv/three-vrm](https://github.com/pixiv/three-vrm) and [@pixiv/three-vrm-animation](https://github.com/pixiv/three-vrm/tree/dev/packages/three-vrm-animation).

[Documentation](https://dohaicuong.github.io/three-vrm-utils/docs/) | [Storybook](https://dohaicuong.github.io/three-vrm-utils/storybook/)

## Install

```bash
npm install three-vrm-utils
```

### Peer dependencies

```bash
npm install react react-dom three @react-three/fiber @pixiv/three-vrm @pixiv/three-vrm-animation
```

## Contributing

See [CONTRIBUTING.md](./CONTRIBUTING.md) for local development setup, writing stories, and the release process.

## License

MIT