@assetpack/plugin-manifest
TypeScript icon, indicating that this package has built-in type declarations

0.8.0 • Public • Published

@assetpack/plugin-manifest

This plugin generates a manifest file so you can easily load your assets in the browser.

Right now it only supports generating a PixiJS manifest file for its Assets loader. See here for more information.

Installation

npm install @assetpack/plugin-manifest

Usage

import { pixiManifest } from "@assetpack/plugin-manifest";

export default {
  ...
  plugins: {
    ...
    manifest: pixiManifest(),
  },
};

In order to generate new bundle entries in the manifest file, you must use the {m} tag on a folder:

```bash
raw-assets
├── preload{m}
│   └── loader.jpg
└── game{m}
    ├── char.png
    └── pikc.png

This will generate two bundles called preload and game in the manifest file.

Options

  • output - The path to the manifest file. Defaults to the output folder defined in your config.
  • createShortcuts - Whether to create shortcuts for each bundle. Defaults to false. If enabled the manifest will try to create the shortest path for an asset. e.g.
{
    "alias": ["game/char.png", "game.png"],
    "src": ["game/char.png"]
}
  • trimExtensions - Whether to trim the extensions from the asset names. Defaults to false. If enabled the manifest will try to create the shortest path for an asset. e.g.
{
    "alias": ["game/char.png", "game/char"],
    "src": ["game/char.png"]
}
  • defaultParser - The default parser to use on a transformed asset
  • parsers - An array of manifest parsers to use.
  • tags - An object containing the tags to use for the plugin. Defaults to { m: "m" }.
    • m - The tag to use for generating a bundle entry in the manifest file.

Readme

Keywords

none

Package Sidebar

Install

npm i @assetpack/plugin-manifest

Weekly Downloads

913

Version

0.8.0

License

MIT

Unpacked Size

32.4 kB

Total Files

9

Last publish

Collaborators

  • zyie