README.md

@assetpack/plugin-texture-packer

AssetPack plugin for generating texture atlases using Texture Packer

Installation

npm install --save-dev @assetpack/plugin-texture-packer

Basic Usage

import { texturePacker } from "@assetpack/plugin-texture-packer";
// or use the pixi specific plugin
// import { pixiTexturePacker } from "@assetpack/plugin-texture-packer";

export default {
  ...
  plugins: {
    ...
    texturePacker: texturePacker(),
  },
};

This plugin requires the {tps} tag to be placed on a folder:

raw-assets
├── game{tps}
    ├── char.png
    └── pickup.png

images can be nested in subfolders:

raw-assets
├── game{tps}
    ├── char.png
    ├── pickup.png
    └── ui
        └── button.png

Options

• texturePacker: Any option that can be passed to Texture Packer can be passed here.
• resolutionOptions: Options for generating resolutions
  • template: A template for denoting the resolution of the images. Defaults to @%%x. Note you must use %% to denote the resolution.
  • resolutions: An object containing the resolutions that the images will be resized to. Defaults to { default: 1, low: 0.5 }.
  • fixedResolution: A resolution used if the fix tag is applied e.g. path/to/spritesheet{tps}{fix} or path/to/spritesheet{tps}{fix}. Resolution must match one found in resolutions. Defaults to default.
  • maximumTextureSize: The maximum size a sprite sheet can be before its split out. Defaults to 4096. This is the equivalent of setting width: 4096, height: 4096 in Texture Packer.
• tags - An object containing the tags to use for the plugin. Defaults to { tps: "tps", fix: "fix", jpg: "jpg" }.
  • tps: The tag used to denote a folder that should be processed by Texture Packer.
  • fix: The tag used to denote that the spritesheet should be fixed to a specific resolution.
  • jpg: The tag used to denote the spritesheet should be saved as a jpg.

Pixi Specific

If you are generating multiple resolutions of a spritesheet right now Pixi does not know how to handle this. To get around this you will need to add a ResolveParser like so:

import { settings, extensions, resolveTextureUrl, ResolveURLParser, ExtensionType } from 'pixi.js';

export const resolveJsonUrl = {
    extension: ExtensionType.ResolveParser,
    test: (value: string): boolean =>
        settings.RETINA_PREFIX.test(value) && value.endsWith('.json'),
    parse: resolveTextureUrl.parse,
} as ResolveURLParser;

extensions.add(resolveJsonUrl);