feat: New option --group-folder

groupFolder option will try to pack sprites within same folder into the same atlas to save drawcalls. Adapting new option `exclusiveTag` from module `maxrects-packer`
soimy · Sep 17, 2020 · 4e6183a · 4e6183a
1 parent 6804108
commit 4e6183a
Show file tree

Hide file tree

Showing 36 changed files with 3,365 additions and 1,494 deletions.
diff --git a/bin/cli.js b/bin/cli.js
@@ -30,6 +30,7 @@ cli
     .option('    --debug', 'draw debug gizmo on atlas (Default: false)', false)
     .option('    --instant', 'instant packing is quicker and skip sorting (Default: false)', false)
     .option('    --seperate-folder', 'Seperate bin based on folder (Default: false)', false)
+    .option('    --group-folder', 'Group bin based on folder (Default: false)', false)
     .option('    --search-dummy', 'Search duplicate sprites to reduce atlas size (Default: false)', false)
     .option('    --save', 'Save configuration for reuse (Default: false)', false)
 
@@ -78,6 +79,7 @@ opt.trim = utils.valueQueue([opt.trim, false]);
 opt.debug = utils.valueQueue([opt.debug, false]);
 opt.instant = utils.valueQueue([opt.instant, false]);
 opt.seperateFolder = utils.valueQueue([opt.seperateFolder, false]);
+opt.groupFolder = utils.valueQueue([opt.groupFolder, false]);
 opt.searchDummy = utils.valueQueue([opt.searchDummy, false]);
 opt.save = utils.valueQueue([opt.save, false]);
 
@@ -97,6 +99,7 @@ atlasifyOptions.debug = opt.debug;
 atlasifyOptions.extrude = opt.extrude;
 atlasifyOptions.instant = opt.instant;
 atlasifyOptions.seperateFolder = opt.seperateFolder;
+atlasifyOptions.groupFolder = opt.groupFolder;
 atlasifyOptions.searchDummy = opt.searchDummy;
 
 //

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -15,7 +15,7 @@
     "doc": "typedoc && touch docs/.nojekyll",
     "doc:json": "typedoc --json docs/typedoc.json",
     "doc:publish": "gh-pages --dotfiles=true -m \"[ci skip] Updates\" -d docs",
-    "test": "cd ./test && node --inspect-brk=9229 ../bin/cli.js --load ./sprite.atl -astr -p 2 -m 1024,1024 --extrude 1 --trim --search-dummy --debug --save ./atlas/ui/",
+    "test": "cd ./test && node --inspect-brk=9229 ../bin/cli.js --group-folder -astr -p 2 -m 1024,1024 --extrude 1 --trim --search-dummy --debug ./atlas",
     "version": "standard-version",
     "commit": "npx git-cz"
   },
@@ -44,17 +44,17 @@
     "@types/mustache": "^0.8.32",
     "@types/node": "^12.12.14",
     "cz-conventional-changelog": "^2.1.0",
-    "gh-pages": "^2.1.1",
-    "patch-package": "^6.2.0",
+    "gh-pages": "^2.2.0",
+    "patch-package": "^6.2.2",
     "postinstall-prepare": "^1.0.1",
     "rimraf": "^2.7.1",
     "standard-version": "^6.0.1",
-    "ts-node": "^8.5.4",
-    "tslib": "^1.10.0",
+    "ts-node": "^8.10.2",
+    "tslib": "^1.13.0",
     "tslint": "^5.20.1",
     "tslint-config-standard": "^8.0.1",
-    "typedoc": "^0.15.3",
-    "typescript": "^3.7.2"
+    "typedoc": "^0.15.8",
+    "typescript": "^3.9.7"
   },
   "dependencies": {
     "@types/pixelmatch": "^5.0.0",
@@ -63,7 +63,7 @@
     "maxrects-packer": "^2.5.0",
     "mustache": "^3.1.0",
     "pixelmatch": "^5.1.0",
-    "resource-loader": "^4.0.0-rc3"
+    "resource-loader": "^4.0.0-rc4"
   },
   "config": {
     "commitizen": {

diff --git a/src/atlasify.ts b/src/atlasify.ts
@@ -81,6 +81,15 @@ export class Options implements IOption {
     public seperateFolder: boolean = false;
     public tag?: boolean;
 
+    /**
+     * Group sheets packing based on folder
+     *
+     * @type {boolean}
+     * @memberof Options
+     */
+    public groupFolder: boolean = false;
+    public exclusiveTag?: boolean;
+
     /**
      * Remove surrounding transparent pixels
      *
@@ -190,6 +199,10 @@ export class Atlasify {
         this._inputPaths = [];
         this._sheets = [];
         if (options.seperateFolder) options.tag = true;
+        if (options.groupFolder) {
+            options.tag = true;
+            options.exclusiveTag = false;
+        }
         this._packer = new MaxRectsPacker<Sheet>(options.width, options.height, options.padding, options);
         this._exporter = new Exporter();
         this._exporter.setExportFormat(this.options.type);
@@ -232,7 +245,7 @@ export class Atlasify {
         } else if (this.options.trimAlpha) {
             sheet.trimAlpha(this.options.alphaTolerence);
         }
-        if (this.options.seperateFolder) {
+        if (this.options.seperateFolder || this.options.groupFolder) {
             const tag = this.getLeafFolder(imgPath);
             if (tag) sheet.tag = tag;
         }

diff --git a/test/atlas/items/coinBronze.png b/test/atlas/items/coinBronze.png
diff --git a/test/atlas/items/coinGold.png b/test/atlas/items/coinGold.png
diff --git a/test/atlas/items/coinSilver.png b/test/atlas/items/coinSilver.png
diff --git a/test/atlas/items/flagBlue1.png b/test/atlas/items/flagBlue1.png
diff --git a/test/atlas/items/flagBlue2.png b/test/atlas/items/flagBlue2.png
diff --git a/test/atlas/items/flagBlue_down.png b/test/atlas/items/flagBlue_down.png
diff --git a/test/atlas/items/flagGreen1.png b/test/atlas/items/flagGreen1.png
diff --git a/test/atlas/items/flagGreen2.png b/test/atlas/items/flagGreen2.png
diff --git a/test/atlas/items/flagGreen_down.png b/test/atlas/items/flagGreen_down.png
diff --git a/test/atlas/items/flagRed1.png b/test/atlas/items/flagRed1.png
diff --git a/test/atlas/items/flagRed2.png b/test/atlas/items/flagRed2.png
diff --git a/test/atlas/items/flagRed_down.png b/test/atlas/items/flagRed_down.png
diff --git a/test/atlas/items/flagYellow1.png b/test/atlas/items/flagYellow1.png
diff --git a/test/atlas/items/flagYellow2.png b/test/atlas/items/flagYellow2.png
diff --git a/test/atlas/items/flagYellow_down.png b/test/atlas/items/flagYellow_down.png
diff --git a/test/atlas/items/gemBlue.png b/test/atlas/items/gemBlue.png
diff --git a/test/atlas/items/gemGreen.png b/test/atlas/items/gemGreen.png
diff --git a/test/atlas/items/gemRed.png b/test/atlas/items/gemRed.png
diff --git a/test/atlas/items/gemYellow.png b/test/atlas/items/gemYellow.png
diff --git a/test/atlas/items/keyBlue.png b/test/atlas/items/keyBlue.png
diff --git a/test/atlas/items/keyGreen.png b/test/atlas/items/keyGreen.png
diff --git a/test/atlas/items/keyRed.png b/test/atlas/items/keyRed.png
diff --git a/test/atlas/items/keyYellow.png b/test/atlas/items/keyYellow.png
diff --git a/test/atlas/items/star.png b/test/atlas/items/star.png