# illustrations

## Unity v3 compatibility

Unity Illustrations v3 is released under Unity's shared major version policy. No illustration API breaking changes are introduced in this release. Upgrade it together with the other `@payfit/unity-*` packages and follow the [Unity Components 2.x to 3.x migration guide](../components/src/docs/guides/migration/Migrating%20from%202.x%20to%203.x.mdx) for component API changes.

This library was generated with [Nx](https://nx.dev).

## Running unit tests

Run `nx test illustrations` to execute the unit tests via [Vitest](https://vitest.dev/).

## Generating assets (pre-build)

Run `pnpm nx run unity-illustrations:pre-build` to regenerate illustration assets.

By default, the command prints a compact summary and periodic progress updates.
Use verbose mode to display full per-asset logs:

- `pnpm nx run unity-illustrations:pre-build --verbose`
- `NX_VERBOSE_LOGGING=true pnpm nx run unity-illustrations:pre-build`