feat: add frame names to spritesheet manifest data (#84)

pixijs · Sep 3, 2024 · 2f76270 · 2f76270
1 parent 4c98058
commit 2f76270
Show file tree

Hide file tree

Showing 3 changed files with 46 additions and 2 deletions.
diff --git a/packages/assetpack/src/texture-packer/texturePacker.ts b/packages/assetpack/src/texture-packer/texturePacker.ts
@@ -19,6 +19,8 @@ export interface TexturePackerOptions extends PluginOptions
         /** The maximum size a sprite sheet can be before its split out */
         maximumTextureSize?: number;
     }
+    /** If true, the frame names for the sprite sheet will be added to the asset meta data. */
+    addFrameNames?: boolean;
 }
 
 function checkForTexturePackerShortcutClashes(
@@ -67,6 +69,7 @@ export function texturePacker(_options: TexturePackerOptions = {}): AssetPipe<Te
                 nameStyle: 'relative',
                 ..._options.texturePacker,
             },
+            addFrameNames: _options.addFrameNames ?? false,
         },
         tags: {
             tps: 'tps',
@@ -130,6 +133,7 @@ export function texturePacker(_options: TexturePackerOptions = {}): AssetPipe<Te
             const assets: Asset[] = [];
 
             let checkedForClashes = false;
+            const imageNames = new Set();
 
             Object.values(resolutionHash).sort((a, b) => b - a).forEach((resolution) =>
             {
@@ -147,6 +151,14 @@ export function texturePacker(_options: TexturePackerOptions = {}): AssetPipe<Te
                         resolution,
                     });
 
+                    if (options.addFrameNames)
+                    {
+                        out.jsons.forEach(({ json }) =>
+                        {
+                            Object.keys(json.frames).forEach((frame) => imageNames.add(frame));
+                        });
+                    }
+
                     const outPromises: Promise<void>[] = [];
 
                     for (let i = 0; i < out.textures.length; i++)
@@ -184,6 +196,11 @@ export function texturePacker(_options: TexturePackerOptions = {}): AssetPipe<Te
 
             await Promise.all(promises);
 
+            if (options.addFrameNames)
+            {
+                asset.metaData.frameNames = Array.from(imageNames);
+            }
+
             return assets;
         },
 

diff --git a/packages/assetpack/test/manifest/Manifest.test.ts b/packages/assetpack/test/manifest/Manifest.test.ts
@@ -121,6 +121,7 @@ describe('Manifest', () =>
                     resolutionOptions: {
                         maximumTextureSize: 512,
                     },
+                    addFrameNames: true,
                 }),
                 mipmap(),
                 compress({
@@ -190,10 +191,34 @@ describe('Manifest', () =>
                     ],
                     data: {
                         tags: {
-                            tps: true,
                             m: true,
+                            tps: true,
+                            frameNames: [
+                                'sprite9.png',
+                                'sprite8.png',
+                                'sprite7.png',
+                                'sprite6.png',
+                                'sprite5.png',
+                                'sprite4.png',
+                                'sprite3.png',
+                                'sprite2.png',
+                                'sprite1.png',
+                                'sprite0.png'
+                            ]
                         },
-                    },
+                        frameNames: [
+                            'sprite9.png',
+                            'sprite8.png',
+                            'sprite7.png',
+                            'sprite6.png',
+                            'sprite5.png',
+                            'sprite4.png',
+                            'sprite3.png',
+                            'sprite2.png',
+                            'sprite1.png',
+                            'sprite0.png'
+                        ]
+                    }
                 },
             ],
         });

diff --git a/packages/docs/docs/guide/pipes/texture-packer.mdx b/packages/docs/docs/guide/pipes/texture-packer.mdx
@@ -67,6 +67,8 @@ export default {
 | resolutionOptions.resolutions        | `object`          | An object containing the resolutions that the images will be resized to.<br />Defaults to `{ default: 1, low: 0.5 }`.    |
 | resolutionOptions.fixedResolution    | `string`          | A resolution used if the fix tag is applied. Resolution must match one found in resolutions.<br />Defaults to `default`. |
 | resolutionOptions.maximumTextureSize | `number`          | The maximum size a sprite sheet can be before its split out.<br />Defaults to `4096`.                                    |
+|                                      |                   |                                                                                                                          |
+| addFrameNames                        | `boolean`         | Whether to add frame names to the data in the manifest<br />Defaults to `false`.                                               |
 
 ## Tags