@remvst/asset-catalog 1.1.0 → 1.2.0

package/lib/generate-sound-catalog.js

@@ -9,6 +9,7 @@ const utils_1 = require("./utils");
 const yargs_1 = __importDefault(require("yargs/yargs"));
 const helpers_1 = require("yargs/helpers");
 const path_1 = require("path");
+const audiosprite_1 = __importDefault(require("audiosprite"));
 async function main() {
     const argv = await (0, yargs_1.default)((0, helpers_1.hideBin)(process.argv))
         .options({
@@ -20,9 +21,9 @@ async function main() {
         },
         'assetDir': {
             type: 'string',
-            default: './package.json',
+            default: '.',
             alias: 'a',
-            describe: 'package.json file to use for the version',
+            describe: 'Asset directory where all the PNGs are located',
         },
         'wav': {
             type: 'boolean',
@@ -39,6 +40,19 @@ async function main() {
             default: true,
             describe: 'Include .mp3 files',
         },
+        'outSpritesheet': {
+            type: 'string',
+            required: false,
+            describe: 'Path to the exported spritesheet (without the extension)',
+        },
+        'spritesheetExcludeCategory': {
+            type: 'string',
+            array: true,
+            required: false,
+            alias: 'x',
+            default: [],
+            describe: 'Exclude certain categories from the spritesheet',
+        },
     })
         .argv;
     const extensions = [];
@@ -54,7 +68,8 @@ async function main() {
     }
     catch (e) { }
     const files = await (0, utils_1.allFiles)(argv.assetDir);
-    const sounds = files.filter(file => extensions.indexOf((0, path_1.extname)(file)) >= 0);
+    const sounds = files.filter(file => extensions.indexOf((0, path_1.extname)(file)) >= 0)
+        .filter(file => (0, path_1.basename)(file, (0, path_1.extname)(file)) !== 'sprites');
     const defs = new Map();
     for (const sound of sounds) {
         const category = (0, utils_1.categoryPath)(argv.assetDir, sound).join('_');
@@ -68,6 +83,48 @@ async function main() {
         }
         defs.get(category).get(filenameWithoutExt).add(sound);
     }
+    const spriteSounds = new Map();
+    let spritesheetJson = null;
+    if (argv.outSpritesheet) {
+        for (const category of defs.keys()) {
+            let isCategoryExcluded = false;
+            for (const exclusion of argv.spritesheetExcludeCategory) {
+                if (category.indexOf(exclusion) !== -1) {
+                    isCategoryExcluded = true;
+                    break;
+                }
+            }
+            if (isCategoryExcluded) {
+                continue;
+            }
+            for (const filenameWithoutExt of defs.get(category).keys()) {
+                const fileSet = defs.get(category).get(filenameWithoutExt);
+                const files = Array.from(fileSet);
+                const pickedFile = files.find(file => (0, path_1.extname)(file) === '.wav') ||
+                    files.find(file => (0, path_1.extname)(file) === '.ogg') ||
+                    files.find(file => (0, path_1.extname)(file) === '.mp3');
+                if (!pickedFile) {
+                    throw new Error('Unable to pick file for sprite in ' + category);
+                }
+                spriteSounds.set(category + '/' + filenameWithoutExt, pickedFile);
+            }
+        }
+        spritesheetJson = await new Promise((resolve, reject) => {
+            const options = {
+                output: argv.outSpritesheet,
+                format: 'howler',
+                export: extensions.map(ext => ext.slice(1)).join(','),
+            };
+            (0, audiosprite_1.default)(Array.from(spriteSounds.values()), options, (err, res) => {
+                if (err) {
+                    reject(err);
+                }
+                else {
+                    resolve(res);
+                }
+            });
+        });
+    }
     const imports = [];
     const definitions = [];
     const funcs = [];
@@ -76,10 +133,38 @@ async function main() {
     soundDefinition += '    constructor(\n';
     soundDefinition += '        readonly basename: string,\n';
     soundDefinition += '        readonly files: string[],\n';
+    soundDefinition += '        readonly sprite: string | null,\n';
     soundDefinition += '        readonly averageFileSize: number,\n';
     soundDefinition += '    ) {}\n';
     soundDefinition += '}\n';
     definitions.push(soundDefinition);
+    if (argv.outSpritesheet) {
+        const modifiedSpritesheetJson = { ...spritesheetJson };
+        modifiedSpritesheetJson.urls = extensions.map(ext => argv.outSpritesheet + ext);
+        let spriteSheetFunc = 'export function sound_spritesheet() {\n';
+        spriteSheetFunc += '    return {\n';
+        spriteSheetFunc += '        urls: [\n';
+        const idealOrder = ['.ogg', '.mp3', '.wav'];
+        const sortedExtensions = extensions.sort((a, b) => idealOrder.indexOf(a) - idealOrder.indexOf(b));
+        for (const extension of sortedExtensions) {
+            const importName = 'sprites_' + extension.slice(1);
+            imports.push(`import ${importName} from '${(0, path_1.relative)((0, path_1.dirname)(argv.outFile), argv.outSpritesheet + extension).replace(/\\/g, '/')}';`);
+            spriteSheetFunc += `            ${importName},\n`;
+        }
+        let totalFileSize = 0;
+        for (const extension of sortedExtensions) {
+            const soundFile = argv.outSpritesheet + extension;
+            const stats = await fs_1.promises.stat(soundFile);
+            totalFileSize += stats.size;
+        }
+        const averageFileSize = Math.round(totalFileSize / files.length);
+        spriteSheetFunc += '        ],\n';
+        spriteSheetFunc += `        sprite: ${JSON.stringify(spritesheetJson.sprite)},\n`;
+        spriteSheetFunc += `        averageFileSize: ${averageFileSize},\n`;
+        spriteSheetFunc += '    }\n';
+        spriteSheetFunc += '};\n';
+        funcs.push(spriteSheetFunc);
+    }
     for (const category of defs.keys()) {
         let func = `export function sound_${category}(): SoundDefinition[] {\n`;
         func += `   return [\n`;
@@ -101,7 +186,9 @@ async function main() {
                 totalFileSize += stats.size;
             }
             const averageFileSize = Math.round(totalFileSize / files.length);
+            const hasSprite = spriteSounds.get(category + '/' + filenameWithoutExt);
             func += '            ],\n';
+            func += `            ${JSON.stringify(hasSprite ? filenameWithoutExt : null)},\n`;
             func += `            ${averageFileSize},\n`;
             func += '        ),\n';
         }

package/lib/utils.d.ts

@@ -2,4 +2,4 @@ export declare function allFiles(path: string): Promise<string[]>;
 export declare function sanitize(string: string): string;
 export declare function camelize(str: string): string;
 export declare function lowerCamelize(str: string): string;
-export declare function categoryPath(assetDir: string, png: string): string[];
+export declare function categoryPath(assetDir: string, filepath: string): string[];

package/lib/utils.js

@@ -34,8 +34,8 @@ function lowerCamelize(str) {
     return camelized.slice(0, 1).toLowerCase() + camelized.slice(1);
 }
 exports.lowerCamelize = lowerCamelize;
-function categoryPath(assetDir, png) {
-    const dir = (0, path_1.dirname)(png);
+function categoryPath(assetDir, filepath) {
+    const dir = (0, path_1.dirname)(filepath);
     const trimmedDir = (0, path_1.relative)(assetDir, dir);
     return trimmedDir
         .split(/[\/\\]/g)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@remvst/asset-catalog",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "description": "",
   "bin": {
     "generate-image-catalog": "./lib/generate-image-catalog.js",
@@ -9,19 +9,21 @@
   "scripts": {
     "build": "rm -rf lib && tsc && chmod +x lib/generate-image-catalog.js lib/generate-sound-catalog.js",
     "test:images": "ts-node src/generate-image-catalog.ts --assetDir=./testData --outFile=testOut/images.ts --outSpritesheet=testOut/spritesheet.png",
-    "test:sounds": "ts-node src/generate-sound-catalog.ts --assetDir=./testData/sounds --outFile=testOut/sounds.ts",
+    "test:sounds": "ts-node src/generate-sound-catalog.ts --assetDir=./testData/sounds --outFile=testOut/sounds.ts --outSpritesheet=testData/sounds/sprites --spritesheetExcludeCategory=jump",
     "test": "npm run test:images && npm run test:sounds",
     "prepublishOnly": "npm i && npm run build"
   },
   "author": "Rémi Vansteelandt",
   "license": "UNLICENSED",
   "dependencies": {
+    "audiosprite": "^0.7.2",
     "bin-pack": "^1.0.2",
     "canvas": "^2.11.2",
     "image-size": "^1.0.2",
     "yargs": "^17.7.2"
   },
   "devDependencies": {
+    "@types/audiosprite": "^0.7.3",
     "@types/bin-pack": "^1.0.3",
     "@types/node": "^18.11.5",
     "@types/yargs": "^17.0.32",

package/src/generate-sound-catalog.ts

@@ -4,7 +4,8 @@ import { promises as fs } from 'fs';
 import { sanitize, allFiles, categoryPath } from './utils';
 import yargs from 'yargs/yargs';
 import { hideBin } from 'yargs/helpers';
-import { dirname, extname, basename, relative } from 'path';
+import { dirname, extname, basename, relative, parse } from 'path';
+import audiosprite from 'audiosprite';
 
 async function main() {
     const argv = await yargs(hideBin(process.argv))
@@ -17,9 +18,9 @@ async function main() {
             },
             'assetDir': {
                 type: 'string',
-                default: './package.json',
+                default: '.',
                 alias: 'a',
-                describe: 'package.json file to use for the version',
+                describe: 'Asset directory where all the PNGs are located',
             },
             'wav': {
                 type: 'boolean',
@@ -36,6 +37,19 @@ async function main() {
                 default: true,
                 describe: 'Include .mp3 files',
             },
+            'outSpritesheet': {
+                type: 'string',
+                required: false,
+                describe: 'Path to the exported spritesheet (without the extension)',
+            },
+            'spritesheetExcludeCategory': {
+                type: 'string',
+                array: true,
+                required: false,
+                alias: 'x',
+                default: [] as string[],
+                describe: 'Exclude certain categories from the spritesheet',
+            },
         })
         .argv;
 
@@ -51,7 +65,8 @@ async function main() {
 
 
     const files = await allFiles(argv.assetDir);
-    const sounds = files.filter(file => extensions.indexOf(extname(file)) >= 0);
+    const sounds = files.filter(file => extensions.indexOf(extname(file)) >= 0)
+        .filter(file => basename(file, extname(file)) !== 'sprites');
 
     const defs = new Map<string, Map<string, Set<string>>>();
 
@@ -71,6 +86,53 @@ async function main() {
         defs.get(category)!.get(filenameWithoutExt)!.add(sound);
     }
 
+    const spriteSounds: Map<string, string> = new Map();
+
+    let spritesheetJson: any = null;
+    if (argv.outSpritesheet) {
+        for (const category of defs.keys()) {
+            let isCategoryExcluded = false;
+            for (const exclusion of argv.spritesheetExcludeCategory) {
+                if (category.indexOf(exclusion) !== -1) {
+                    isCategoryExcluded = true;
+                    break;
+                }
+            }
+            if (isCategoryExcluded) {
+                continue;
+            }
+
+            for (const filenameWithoutExt of defs.get(category)!.keys()) {
+                const fileSet = defs.get(category)!.get(filenameWithoutExt)!;
+
+                const files = Array.from(fileSet);
+                const pickedFile = files.find(file => extname(file) === '.wav') ||
+                    files.find(file => extname(file) === '.ogg') ||
+                    files.find(file => extname(file) === '.mp3');
+                if (!pickedFile) {
+                    throw new Error('Unable to pick file for sprite in ' + category);
+                }
+                spriteSounds.set(category + '/' + filenameWithoutExt, pickedFile);
+            }
+        }
+
+        spritesheetJson = await new Promise((resolve, reject) => {
+            const options: audiosprite.Option = {
+                output: argv.outSpritesheet,
+                format: 'howler',
+                export: extensions.map(ext => ext.slice(1)).join(','),
+            };
+
+            audiosprite(Array.from(spriteSounds.values()), options, (err, res) => {
+                if (err) {
+                    reject(err);
+                } else {
+                    resolve(res);
+                }
+            });
+        });
+    }
+
     const imports = [];
     const definitions = [];
     const funcs = [];
@@ -80,11 +142,47 @@ async function main() {
     soundDefinition += '    constructor(\n';
     soundDefinition += '        readonly basename: string,\n';
     soundDefinition += '        readonly files: string[],\n';
+    soundDefinition += '        readonly sprite: string | null,\n';
     soundDefinition += '        readonly averageFileSize: number,\n';
     soundDefinition += '    ) {}\n';
     soundDefinition += '}\n';
     definitions.push(soundDefinition);
 
+    if (argv.outSpritesheet) {
+        const modifiedSpritesheetJson = { ...spritesheetJson };
+        modifiedSpritesheetJson.urls = extensions.map(ext => argv.outSpritesheet + ext);
+
+        let spriteSheetFunc = 'export function sound_spritesheet() {\n';
+        spriteSheetFunc += '    return {\n';
+        spriteSheetFunc += '        urls: [\n';
+
+
+        const idealOrder = ['.ogg', '.mp3', '.wav'];
+        const sortedExtensions = extensions.sort((a, b) => idealOrder.indexOf(a) - idealOrder.indexOf(b));
+        for (const extension of sortedExtensions) {
+            const importName = 'sprites_' + extension.slice(1);
+            imports.push(`import ${importName} from '${relative(dirname(argv.outFile), argv.outSpritesheet + extension).replace(/\\/g, '/')}';`);
+
+            spriteSheetFunc += `            ${importName},\n`;
+        }
+
+        let totalFileSize = 0;
+        for (const extension of sortedExtensions) {
+            const soundFile = argv.outSpritesheet + extension;
+            const stats = await fs.stat(soundFile);
+            totalFileSize += stats.size;
+        }
+
+        const averageFileSize = Math.round(totalFileSize / files.length);
+
+        spriteSheetFunc += '        ],\n';
+        spriteSheetFunc += `        sprite: ${JSON.stringify(spritesheetJson.sprite)},\n`;
+        spriteSheetFunc += `        averageFileSize: ${averageFileSize},\n`;
+        spriteSheetFunc += '    }\n';
+        spriteSheetFunc += '};\n';
+        funcs.push(spriteSheetFunc);
+    }
+
     for (const category of defs.keys()) {
         let func = `export function sound_${category}(): SoundDefinition[] {\n`;
         func += `   return [\n`;
@@ -111,7 +209,10 @@ async function main() {
 
             const averageFileSize = Math.round(totalFileSize / files.length);
 
+            const hasSprite = spriteSounds.get(category + '/' + filenameWithoutExt)!;
+
             func += '            ],\n';
+            func += `            ${JSON.stringify(hasSprite ? filenameWithoutExt : null)},\n`;
             func += `            ${averageFileSize},\n`;
             func += '        ),\n';
         }

package/src/utils.ts

@@ -34,8 +34,8 @@ export function lowerCamelize(str: string): string {
     return camelized.slice(0, 1).toLowerCase() + camelized.slice(1);
 }
 
-export function categoryPath(assetDir: string, png: string): string[] {
-    const dir = dirname(png);
+export function categoryPath(assetDir: string, filepath: string): string[] {
+    const dir = dirname(filepath);
     const trimmedDir = relative(assetDir, dir);
     return trimmedDir
         .split(/[\/\\]/g)