# Custom Material

The `Custom Material` toolkit provides a variety of special materials, such as infinite grids and planar shadows, etc.
However, the material of this warehouse will either rely on the control of the `Script`, or use the `multi shader pass`
to provide a factory class, or rely on special Mesh data. So each material is used in a different way.

Due to the particularity of various materials, a README document is provided under each material folder. For the
principle and usage of each material, please refer to the README document under each folder.

## Features

- 🔲  **[Plain Color Material](src/plain-color)** - Plain color material
- ⚔️  **[Grid Material](src/grid)** - Infinity grid material
- 🗳  **[Planar Shadow Material](src/planar-shadow)** - Two-pass shadow on the planar
- 🍞  **[Bake PBR Material](src/bake-pbr)** - Bake texture with ibl lighting

## npm

The `Custom Material` is published on npm with full typing support. To install, use:

```sh
npm install @galacean/engine-toolkit-custom-material
```

This will allow you to import package entirely using:

```javascript
import * as TOOLKIT from "@galacean/engine-toolkit-custom-material";
```

or individual classes using:

```javascript
import { PlanarShadowShaderFactory } from "@galacean/engine-toolkit-custom-material";
```

## Links

- [Repository](https://github.com/galacean/engine-toolkit)
- [Examples](https://oasisengine.cn/#/examples/latest/skeleton-viewer)
- [Documentation](https://oasisengine.cn/#/docs/latest/cn/install)
- [API References](https://oasisengine.cn/#/api/latest/core)

## License

The engine is released under the [MIT](https://opensource.org/licenses/MIT) license. See LICENSE file.