-
Notifications
You must be signed in to change notification settings - Fork 234
/
Copy pathPhotoshopToSpine.jsx
1727 lines (1534 loc) · 56.6 KB
/
PhotoshopToSpine.jsx
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#target photoshop
app.bringToFront();
// https://github.com/EsotericSoftware/spine-scripts/tree/master/photoshop
// This script exports Adobe Photoshop layers as individual PNGs. It also
// writes a JSON file which can be imported into Spine where the images
// will be displayed in the same positions and draw order.
// Copyright (c) 2012-2022, Esoteric Software
// All rights reserved.
// Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
// * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
// * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
// * Neither the name of Esoteric Software nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
var scriptVersion = "7.40"; // This is incremented every time the script is modified, so you know if you have the latest.
var revealAll = false; // Set to true to enlarge the canvas so layers are not cropped.
var legacyJson = true; // Set to false to output the newer Spine JSON format.
var cs2 = parseInt(app.version) < 10, cID = charIDToTypeID, sID = stringIDToTypeID, tID = typeIDToStringID;
var originalDoc, settings, progress, cancel, errors, lastLayerName;
try {
originalDoc = activeDocument;
} catch (ignored) {}
var defaultSettings = {
ignoreHiddenLayers: false,
ignoreBackground: true,
writeTemplate: false,
writeJson: true,
trimWhitespace: true,
selectionOnly: false,
scale: 1,
padding: 1,
imagesDir: "./images/",
jsonPath: "./",
};
loadSettings();
function run () {
showProgress();
var selectedLayers;
if (settings.selectionOnly) {
selectedLayers = getSelectedLayers();
if (!selectedLayers.length) {
alert("At least one layer must be selected when \"Selection only\" is checked.");
return;
}
}
errors = [];
// Output dirs.
var jsonFile = new File(jsonPath(settings.jsonPath));
jsonFile.parent.create();
var imagesDir = absolutePath(settings.imagesDir);
var imagesFolder = new Folder(imagesDir);
imagesFolder.create();
var docWidth = originalDoc.width.as("px"), docHeight = originalDoc.height.as("px");
var xOffSet = rulerOrigin("H"), yOffSet = rulerOrigin("V");
try {
deleteDocumentAncestorsMetadata();
} catch (ignored) {}
originalDoc.duplicate();
deselectLayers();
if (revealAll) activeDocument.revealAll();
try {
convertToRGB();
} catch (ignored) {}
if (activeDocument.mode != DocumentMode.RGB) {
alert("Please change the image mode to RGB color.");
return;
}
// Output template image.
if (settings.writeTemplate) {
if (settings.scale != 1) {
storeHistory();
scaleImage(settings.scale);
}
var file = new File(imagesDir + "template.png");
if (file.exists) file.remove();
savePNG(file);
if (settings.scale != 1) restoreHistory();
}
if (!settings.jsonPath && !settings.imagesDir) return;
rasterizeAll();
// Add a history item to prevent layer visibility from changing by the active layer being reset to the top.
var topLayer = activeDocument.artLayers.add();
topLayer.name = "Collecting layers...";
// Collect and hide layers.
var rootLayers = [], layers = [];
var context = {
first: hasBackgroundLayer() ? 0 : 1,
index: getLayerCount() - 1,
total: 0
};
initializeLayers(context, selectedLayers, null, rootLayers);
showProgress("Collecting layers...", context.total);
collectLayers(rootLayers, layers, []);
// Store the bones, slot names, and layers for each skin.
var bones = { _root: { name: "root", x: 0, y: 0, children: [] } };
var slots = {}, slotsCount = 0;
var skins = { _default: [] }, skinsCount = 0;
var skinDuplicates = {};
var totalLayerCount = 0;
outer:
for (var i = layers.length - 1; i >= 0; i--) {
if (cancel) return;
var layer = layers[i];
var name = stripTags(layer.name).replace(/.png$/, "");
name = name.replace(/[\\:"*?<>|]/g, "").replace(/^\.+$/, "").replace(/^__drag$/, ""); // Illegal.
name = layer.applyNamePatterns(name);
if (!name) continue;
name = name.replace(/^(con|prn|aux|nul|com[0-9]|lpt[0-9])(\..*)?$/i, ""); // Windows.
if (!name || name.length > 255) {
error("Layer name is not a valid attachment name:\n\n" + layer.name);
continue;
}
var folderPath = layer.folders("");
if (startsWith(name, "/")) {
name = name.substring(1);
layer.attachmentName = name;
} else
layer.attachmentName = folderPath + name;
layer.attachmentPath = layer.findTagValue("path:");
if (!layer.attachmentPath)
layer.attachmentPath = layer.attachmentName;
else if (startsWith(layer.attachmentPath, "/"))
layer.attachmentPath = layer.attachmentPath.substring(1);
else
layer.attachmentPath = folderPath + layer.attachmentPath;
var scale = layer.findTagValue("scale:");
if (!scale) scale = 1;
layer.scale = parseFloat(scale);
if (isNaN(layer.scale)) error("Invalid scale " + scale + ":\n\n" + layer.path());
var bone = null, boneLayer = layer.findTagLayer("bone");
if (boneLayer) {
var parent = boneLayer.getParentBone(bones);
var boneName = boneLayer.findTagValue("bone");
bone = get(bones, boneName);
if (bone) {
if (parent != bone.parent) {
error("Multiple layers for the \"" + boneName + "\" bone have different parent bones:\n\n"
+ bone.layer.path() + "\n"
+ boneLayer.path());
continue;
}
} else {
set(bones, boneName, bone = { name: boneName, parent: parent, children: [], layer: boneLayer });
parent.children.push(bone);
}
layer.updateBounds();
bone.x = layer.left * settings.scale - settings.padding;
bone.x += layer.width * settings.scale / 2 + settings.padding;
bone.y = layer.bottom * settings.scale + settings.padding;
bone.y -= layer.height * settings.scale / 2 + settings.padding;
bone.y = docHeight * settings.scale - bone.y;
// Make relative to the Photoshop document ruler origin.
bone.x -= xOffSet * settings.scale;
bone.y -= (docHeight - yOffSet) * settings.scale;
}
var skinName = null;
var skinLayer = layer.findTagLayer("skin");
if (skinLayer) {
skinName = skinLayer.getTagValue("skin");
if (startsWith(skinName, "/"))
skinName = skinName.substring(1);
else if (skinLayer.parent)
skinName = skinLayer.parent.folders("") + skinName;
if (skinName && skinName.toLowerCase() == "default") {
error("The skin name \"default\" is reserved:\n\n" + layer.path() + "\n\nPlease use a different name.");
continue;
}
}
if (!skinName) skinName = "default";
layer.skinName = skinName;
if (skinName == "default")
layer.placeholderName = layer.attachmentName;
else if (!startsWith(layer.attachmentName, skinName + "/")) { // Should never happen.
error("Expected attachment name \"" + layer.attachmentName + "\" to start with skin name: " + skinName + "/");
continue;
} else
layer.placeholderName = layer.attachmentName.substring(skinName.length + 1);
layer.mesh = layer.findTagValue("mesh", true);
layer.slotName = layer.findTagValue("slot") || name;
var slot = get(slots, layer.slotName);
if (!slot) {
slotsCount++;
set(slots, layer.slotName, slot = {
bone: bone,
attachment: layer.wasVisible ? layer.placeholderName : null,
placeholders: {},
attachments: false,
layers: {}
});
} else if (!slot.attachment && layer.wasVisible)
slot.attachment = layer.placeholderName;
set(slot.layers, layer.attachmentName, layer);
if (layer.blendMode == "linearDodge")
slot.blend = "additive";
else if (layer.blendMode == "multiply")
slot.blend = "multiply";
else if (layer.blendMode == "screen")
slot.blend = "screen";
var placeholders = get(slot.placeholders, skinName);
if (!placeholders)
set(slot.placeholders, skinName, placeholders = {});
else {
var existing = get(placeholders, layer.placeholderName);
if (existing) { // Skin has duplicate placeholders.
var key = layer.slotName + "|^`" + skinName;
remove(skinDuplicates, key, existing);
add(skinDuplicates, key, existing);
add(skinDuplicates, key, layer);
}
}
set(placeholders, layer.placeholderName, layer);
var skinSlots = get(skins, skinName);
if (!skinSlots) {
set(skins, skinName, skinSlots = {});
skinsCount++;
}
add(skinSlots, layer.slotName, layer);
totalLayerCount++;
}
// Error if a skin has multiple skin placeholders with the same name.
for (var key in skinDuplicates) {
if (!skinDuplicates.hasOwnProperty(key)) continue;
var layers = skinDuplicates[key];
var message = "Multiple layers for the \"" + layers[0].skinName + "\" skin in the \"" + layers[0].slotName
+ "\" slot have the same name \"" + layers[0].placeholderName + "\":\n";
for (var i = 0, n = layers.length; i < n; i++)
message += "\n" + layers[i].path();
error(message + "\n\nRename or use the [ignore] tag for these layers.");
}
var slotDuplicates = {};
for (var slotName in slots) {
if (!slots.hasOwnProperty(slotName)) continue;
var slot = slots[slotName];
// Error if a source mesh isn't found in the same slot.
var layers = slot.layers;
for (var attachmentName in layers) {
if (!layers.hasOwnProperty(attachmentName)) continue;
var layer = layers[attachmentName];
if (!layer.mesh) continue;
if (layer.mesh === true) continue;
var source = get(layers, layer.mesh);
if (!source) {
error("Source mesh \"" + layer.mesh + "\" not found in slot \"" + stripName(slotName) + "\":\n\n"
+ layer.path() + "\n\nPrepend the skin name, if any. For example:\nskinName/" + layer.mesh);
continue;
}
if (!source.mesh) {
error("Layer \"" + source.path() + "\" is not a mesh:\n\n" + layer.path());
continue;
}
layer.mesh = source;
}
// Error if a skin placeholder has the same name as a default skin attachment.
var defaultPlaceholders = get(slot.placeholders, "default");
if (!defaultPlaceholders) continue;
for (var skinName in slot.placeholders) {
if (!slot.placeholders.hasOwnProperty(skinName)) continue;
var placeholders = slot.placeholders[skinName];
if (stripName(skinName) == "default") continue;
for (var placeholderName in placeholders) {
if (!placeholders.hasOwnProperty(placeholderName)) continue;
var existing = get(defaultPlaceholders, stripName(placeholderName));
if (existing) {
var layer = placeholders[placeholderName];
remove(slotDuplicates, layer.slotName, existing);
add(slotDuplicates, layer.slotName, existing);
add(slotDuplicates, layer.slotName, layer);
}
}
}
}
for (var slotName in slotDuplicates) {
if (!slotDuplicates.hasOwnProperty(slotName)) continue;
var layers = slotDuplicates[slotName];
var message = "Multiple layers for the \"" + layers[0].slotName + "\" slot have the same name \"" + layers[0].placeholderName + "\":\n";
for (var i = 0, n = layers.length; i < n; i++)
message += "\n" + layers[i].path();
error(message + "\n\nRename or use the [ignore] tag for these layers.");
}
var n = errors.length;
if (n) {
var first = errors[0];
var file = null;
if (n > 1) {
try {
var all = "";
for (var i = 0; i < n; i++) {
if (i > 0) all += "---\n";
all += errors[i].replace(/\n\n/g, "\n") + "\n";
}
file = new File(jsonFile.parent + "/errors.txt");
file.parent.create();
file.encoding = "UTF-8";
file.remove();
file.open("w", "TEXT");
file.lineFeed = "\n";
file.write(all);
file.close();
if (n == 2)
first += "\n\nSee errors.txt for 1 additional error.";
else
first += "\n\nSee errors.txt for " + (n - 1) + " additional errors.";
} catch (e) {
if (n == 2)
first += "\n\nUnable to write 1 additional error to errors.text.\n"+e;
else
first += "\n\nUnable to write " + (n - 1) + " additional errors to errors.txt.\n"+e;
}
}
alert(first);
if (file) file.execute();
return;
}
// Add a history item to prevent layer visibility from changing by restoreHistory.
topLayer.name = "Processing layers...";
showProgress("Processing layers...", totalLayerCount);
// Output skins.
var jsonSkins = "", layerCount = 0, writeImages = settings.imagesDir, tabs = legacyJson ? '\t\t' : '\t\t\t';
for (var skinName in skins) {
if (!skins.hasOwnProperty(skinName)) continue;
var skinSlots = skins[skinName];
skinName = stripName(skinName);
var jsonSkin = "";
for (var slotName in skinSlots) {
if (!skinSlots.hasOwnProperty(slotName)) continue;
var slot = slots[slotName];
var bone = slot.bone;
var skinLayers = skinSlots[slotName];
slotName = stripName(slotName);
var jsonSlot = "";
for (var i = skinLayers.length - 1; i >= 0; i--) {
layerCount++;
var layer = skinLayers[i];
layer.show();
incrProgress(layer.name);
if (cancel) return;
var attachmentName = layer.attachmentName, attachmentPath = layer.attachmentPath, placeholderName = layer.placeholderName, mesh = layer.mesh;
var scale = layer.scale, overlays = layer.overlays;
var trim = layer.findTagValue("trim");
if (trim != null)
trim = trim != "false";
else
trim = settings.trimWhitespace;
if (layer.isGroup) {
layer.select();
merge();
layer = new Layer(layer.id, layer.parent, layer.selected);
}
layer.rasterizeStyles();
for (var ii = 0, nn = overlays.length; ii < nn; ii++) {
var overlay = overlays[ii];
overlay.moveAbove(layer);
overlay.setClippingMask(true);
overlay.show();
}
var bounds = mesh && mesh != true ? mesh : layer;
bounds.updateBounds();
if (!bounds.width || !bounds.height) {
layer.hide();
continue;
}
slot.attachments = true;
if (writeImages) storeHistory();
var x, y, width, height, docHeightCropped;
if (trim) {
x = bounds.left;
y = bounds.top;
width = bounds.width;
height = bounds.height;
activeDocument.crop([x - xOffSet, y - yOffSet, bounds.right - xOffSet, bounds.bottom - yOffSet], 0, width, height);
x *= settings.scale;
y *= settings.scale;
docHeightCropped = height;
} else {
x = 0;
y = 0;
width = docWidth;
height = docHeightCropped = docHeight;
}
width = width * settings.scale + settings.padding * 2;
height = height * settings.scale + settings.padding * 2;
// Save image.
if (writeImages) {
scaleImage(settings.scale * scale);
if (settings.padding > 0) activeDocument.resizeCanvas(width * scale, height * scale, AnchorPosition.MIDDLECENTER);
var file = new File(imagesDir + attachmentPath + ".png");
file.parent.create();
savePNG(file);
restoreHistory();
}
if (layerCount < totalLayerCount) layer.hide();
var center = mesh ? 0 : 0.5;
x += Math.round(width) * center - settings.padding;
y = docHeightCropped - (y + Math.round(height) * center - settings.padding);
width = Math.round(width * scale);
height = Math.round(height * scale);
// Make relative to the Photoshop document ruler origin.
x -= xOffSet * settings.scale;
y -= docHeightCropped - yOffSet * settings.scale;
if (bone) { // Make relative to parent bone.
x -= bone.x;
y -= bone.y;
}
var json = "\t" + tabs + quote(placeholderName) + ': { ';
if (attachmentName != placeholderName) json += '"name": ' + quote(attachmentName) + ', ';
if (attachmentName != attachmentPath) json += '"path": ' + quote(attachmentPath) + ', ';
if (mesh) {
if (mesh === true)
json += '"type": "mesh", ';
else {
json += '"type": "linkedmesh", "parent": "' + mesh.placeholderName + '", ';
if (mesh.skinName) json += '"skin": "' + mesh.skinName + '", ';
}
json += '"width": ' + width + ', "height": ' + height + ', "vertices": [ ';
json += (x + width) + ', ' + (y - height) + ', ';
json += x + ', ' + (y - height) + ', ';
json += x + ', ' + y + ', ';
json += (x + width) + ', ' + y + ' ], "uvs": [ 1, 1, 0, 1, 0, 0, 1, 0 ], "triangles": [ 1, 2, 3, 1, 3, 0 ], "hull": 4, "edges": [ 0, 2, 2, 4, 4, 6, 0, 6 ]';
} else {
json += '"x": ' + x + ', "y": ' + y + ', "width": ' + width + ', "height": ' + height;
if (scale != 1) json += ', "scaleX": ' + (1 / scale) + ', "scaleY": ' + (1 / scale);
}
json += ' },\n';
jsonSlot += json;
}
if (jsonSlot) jsonSkin += tabs + quote(slotName) + ': {\n' + jsonSlot.substring(0, jsonSlot.length - 2) + '\n' + tabs + '\},\n';
}
if (jsonSkin) {
if (legacyJson)
jsonSkins += '\t"' + skinName + '": {\n' + jsonSkin.substring(0, jsonSkin.length - 2) + '\n\t},\n';
else
jsonSkins += '\t{\n\t\t"name": ' + quote(skinName) + ',\n\t\t"attachments": {\n' + jsonSkin.substring(0, jsonSkin.length - 2) + '\n\t\t}\n\t},\n';
}
}
lastLayerName = null;
activeDocument.close(SaveOptions.DONOTSAVECHANGES);
// Output skeleton.
var json = '{ "skeleton": { "images": "' + imagesDir + '" },\n';
json += '"PhotoshopToSpine": { "scale": ' + settings.scale + ', "padding": ' + settings.padding + ', "trim": ' + settings.trimWhitespace + ' },\n';
json += '"bones": [\n';
// Output bones.
function outputBone (bone) {
var json = bone.parent ? ',\n' : '';
json += '\t{ "name": ' + quote(bone.name);
var x = bone.x, y = bone.y;
if (bone.parent) {
x -= bone.parent.x;
y -= bone.parent.y;
json += ', "parent": ' + quote(bone.parent.name);
}
if (x) json += ', "x": ' + x;
if (y) json += ', "y": ' + y;
json += ' }';
for (var i = 0, n = bone.children.length; i < n; i++)
json += outputBone(bone.children[i]);
return json;
}
for (var boneName in bones) {
if (cancel) return;
if (!bones.hasOwnProperty(boneName)) continue;
var bone = bones[boneName];
if (!bone.parent) json += outputBone(bone);
}
json += '\n],\n"slots": [\n';
// Output slots.
var slotIndex = 0;
for (var slotName in slots) {
if (cancel) return;
if (!slots.hasOwnProperty(slotName)) continue;
var slot = slots[slotName];
if (!slot.attachments) continue;
slotName = stripName(slotName);
json += '\t{ "name": ' + quote(slotName) + ', "bone": ' + quote(slot.bone ? slot.bone.name : "root");
if (slot.attachment) json += ', "attachment": ' + quote(slot.attachment);
if (slot.blend) json += ', "blend": ' + quote(slot.blend);
json += ' }';
slotIndex++;
json += slotIndex < slotsCount ? ',\n' : '\n';
}
json += '],\n';
if (jsonSkins) {
if (legacyJson)
json += '"skins": {\n' + jsonSkins.substring(0, jsonSkins.length - 2) + '\n},\n';
else
json += '"skins": [\n' + jsonSkins.substring(0, jsonSkins.length - 2) + '\n],\n';
}
json += '"animations": { "animation": {} }\n}';
// Output JSON file.
if (settings.writeJson && settings.jsonPath) {
if (cancel) return;
jsonFile.encoding = "UTF-8";
jsonFile.remove();
jsonFile.open("w", "TEXT");
jsonFile.lineFeed = "\n";
jsonFile.write(json);
jsonFile.close();
}
}
// Settings dialog:
function showSettingsDialog () {
if (parseInt(app.version) < 9) {
alert("Photoshop CS2 or later is required.");
return;
}
if (!originalDoc) {
alert("Please open a document before running the PhotoshopToSpine script.");
return;
}
try {
decodeURI(activeDocument.path);
} catch (e) {
alert("Please save the document before running the PhotoshopToSpine script.");
return;
}
// Layout.
var dialog, group;
try {
dialog = new Window("dialog", "PhotoshopToSpine v" + scriptVersion);
} catch (e) {
throw new Error("\n\nScript is unable to create a Window. Your Photoshop installation may be broken and may need to be reinstalled.\n\n" + e.message);
}
dialog.alignChildren = "fill";
try {
dialog.add("image", undefined, new File(scriptDir() + "logo.png"));
} catch (ignored) {}
var settingsGroup = dialog.add("panel", undefined, "Settings");
settingsGroup.margins = [10,15,10,10];
settingsGroup.alignChildren = "fill";
var checkboxGroup = settingsGroup.add("group");
checkboxGroup.alignChildren = ["left", ""];
checkboxGroup.orientation = "row";
group = checkboxGroup.add("group");
group.orientation = "column";
group.alignChildren = ["left", ""];
var ignoreHiddenLayersCheckbox = group.add("checkbox", undefined, " Ignore hidden layers");
ignoreHiddenLayersCheckbox.value = settings.ignoreHiddenLayers;
var ignoreBackgroundCheckbox = group.add("checkbox", undefined, " Ignore background layer");
ignoreBackgroundCheckbox.value = settings.ignoreBackground;
var trimWhitespaceCheckbox = group.add("checkbox", undefined, " Trim whitespace");
trimWhitespaceCheckbox.value = settings.trimWhitespace;
group = checkboxGroup.add("group");
group.orientation = "column";
group.alignChildren = ["left", ""];
group.alignment = ["", "top"];
var writeJsonCheckbox = group.add("checkbox", undefined, " Write Spine JSON");
writeJsonCheckbox.value = settings.writeJson;
var writeTemplateCheckbox = group.add("checkbox", undefined, " Write template image");
writeTemplateCheckbox.value = settings.writeTemplate;
var selectionOnlyCheckbox = group.add("checkbox", undefined, " Selection only");
selectionOnlyCheckbox.value = settings.selectionOnly;
var scaleText, paddingText, scaleSlider, paddingSlider;
if (!cs2) {
var slidersGroup = settingsGroup.add("group");
group = slidersGroup.add("group");
group.orientation = "column";
group.alignChildren = ["right", ""];
group.add("statictext", undefined, "Scale:");
group.add("statictext", undefined, "Padding:");
group = slidersGroup.add("group");
group.orientation = "column";
scaleText = group.add("edittext", undefined, settings.scale * 100);
scaleText.characters = 4;
paddingText = group.add("edittext", undefined, settings.padding);
paddingText.characters = 4;
group = slidersGroup.add("group");
group.orientation = "column";
group.add("statictext", undefined, "%");
group.add("statictext", undefined, "px");
group = slidersGroup.add("group");
group.orientation = "column";
group.alignChildren = ["fill", ""];
group.alignment = ["fill", ""];
scaleSlider = group.add("slider", undefined, settings.scale * 100, 1, 400);
paddingSlider = group.add("slider", undefined, settings.padding, 0, 4);
} else {
group = settingsGroup.add("group");
group.add("statictext", undefined, "Scale:");
scaleText = group.add("edittext", undefined, settings.scale * 100);
scaleText.preferredSize.width = 50;
scaleSlider = settingsGroup.add("slider", undefined, settings.scale * 100, 1, 400);
group = settingsGroup.add("group");
group.add("statictext", undefined, "Padding:");
paddingText = group.add("edittext", undefined, settings.padding);
paddingText.preferredSize.width = 50;
paddingSlider = settingsGroup.add("slider", undefined, settings.padding, 0, 4);
}
if (cs2) {
ignoreHiddenLayersCheckbox.preferredSize.width = 150;
ignoreBackgroundCheckbox.preferredSize.width = 150;
trimWhitespaceCheckbox.preferredSize.width = 150;
writeJsonCheckbox.preferredSize.width = 150;
writeTemplateCheckbox.preferredSize.width = 150;
selectionOnlyCheckbox.preferredSize.width = 150;
}
var outputPathGroup = dialog.add("panel", undefined, "Output Paths");
outputPathGroup.alignChildren = ["fill", ""];
outputPathGroup.margins = [10,15,10,10];
var imagesDirText, imagesDirPreview, jsonPathText, jsonPathPreview;
if (!cs2) {
var textGroup = outputPathGroup.add("group");
textGroup.orientation = "column";
textGroup.alignChildren = ["fill", ""];
group = textGroup.add("group");
group.add("statictext", undefined, "Images:");
imagesDirText = group.add("edittext", undefined, settings.imagesDir);
imagesDirText.alignment = ["fill", ""];
imagesDirPreview = textGroup.add("statictext", undefined, "");
imagesDirPreview.maximumSize.width = 260;
group = textGroup.add("group");
var jsonLabel = group.add("statictext", undefined, "JSON:");
jsonLabel.justify = "right";
jsonLabel.minimumSize.width = 41;
jsonPathText = group.add("edittext", undefined, settings.jsonPath);
jsonPathText.alignment = ["fill", ""];
jsonPathPreview = textGroup.add("statictext", undefined, "");
jsonPathPreview.maximumSize.width = 260;
} else {
outputPathGroup.add("statictext", undefined, "Images:");
imagesDirText = outputPathGroup.add("edittext", undefined, settings.imagesDir);
imagesDirText.alignment = "fill";
outputPathGroup.add("statictext", undefined, "JSON:");
jsonPathText = outputPathGroup.add("edittext", undefined, settings.jsonPath);
jsonPathText.alignment = "fill";
}
var buttonGroup = dialog.add("group");
var helpButton;
if (!cs2) helpButton = buttonGroup.add("button", undefined, "Help");
group = buttonGroup.add("group");
group.alignment = ["fill", ""];
group.alignChildren = ["right", ""];
var runButton = group.add("button", undefined, "OK");
var cancelButton = group.add("button", undefined, "Cancel");
// Tooltips.
writeTemplateCheckbox.helpTip = "When checked, a PNG is written for the currently visible layers.";
writeJsonCheckbox.helpTip = "When checked, a Spine JSON file is written.";
trimWhitespaceCheckbox.helpTip = "When checked, blank pixels around the edges of each image are removed.";
selectionOnlyCheckbox.helpTip = "When checked, only the selected items are processed.";
scaleSlider.helpTip = "Scales the PNG files. Useful when using higher resolution art in Photoshop than in Spine.";
paddingSlider.helpTip = "Blank pixels around the edge of each image. Can avoid aliasing artifacts for opaque pixels along the image edge.";
imagesDirText.helpTip = "The folder to write PNGs. Begin with \"./\" to be relative to the PSD file. Blank to disable writing PNGs.";
jsonPathText.helpTip = "Output JSON file if ending with \".json\", else the folder to write the JSON file. Begin with \"./\" to be relative to the PSD file. Blank to disable writing a JSON file.";
// Events.
scaleText.onChanging = function () { scaleSlider.value = scaleText.text; };
scaleSlider.onChanging = function () { scaleText.text = Math.round(scaleSlider.value); };
paddingText.onChanging = function () { paddingSlider.value = paddingText.text; };
paddingSlider.onChanging = function () { paddingText.text = Math.round(paddingSlider.value); };
cancelButton.onClick = function () {
cancel = true;
dialog.close();
return;
};
if (!cs2) helpButton.onClick = showHelpDialog;
jsonPathText.onChanging = function () {
var text = jsonPathText.text ? jsonPath(jsonPathText.text) : "<no JSON output>";
if (!cs2) {
jsonPathPreview.text = text;
jsonPathPreview.helpTip = text;
} else
jsonPathText.helpTip = text;
};
imagesDirText.onChanging = function () {
var text = imagesDirText.text ? absolutePath(imagesDirText.text) : "<no image output>";
if (!cs2) {
imagesDirPreview.text = text;
imagesDirPreview.helpTip = text;
} else
imagesDirText.helpTip = text;
};
// Run now.
jsonPathText.onChanging();
imagesDirText.onChanging();
function updateSettings () {
settings.ignoreHiddenLayers = ignoreHiddenLayersCheckbox.value;
settings.ignoreBackground = ignoreBackgroundCheckbox.value;
settings.writeTemplate = writeTemplateCheckbox.value;
settings.writeJson = writeJsonCheckbox.value;
settings.trimWhitespace = trimWhitespaceCheckbox.value;
settings.selectionOnly = selectionOnlyCheckbox.value;
var scaleValue = parseFloat(scaleText.text);
if (scaleValue > 0 && scaleValue <= 400) settings.scale = scaleValue / 100;
settings.imagesDir = imagesDirText.text;
settings.jsonPath = jsonPathText.text;
var paddingValue = parseInt(paddingText.text);
if (paddingValue >= 0) settings.padding = paddingValue;
}
runButton.onClick = function () {
if (scaleText.text <= 0 || scaleText.text > 400) {
alert("Scale must be between > 0 and <= 400.");
return;
}
if (paddingText.text < 0) {
alert("Padding must be >= 0.");
return;
}
updateSettings();
saveSettings();
ignoreHiddenLayersCheckbox.enabled = false;
ignoreBackgroundCheckbox.enabled = false;
writeTemplateCheckbox.enabled = false;
writeJsonCheckbox.enabled = false;
trimWhitespaceCheckbox.enabled = false;
selectionOnlyCheckbox.enabled = false;
scaleText.enabled = false;
scaleSlider.enabled = false;
paddingText.enabled = false;
paddingSlider.enabled = false;
imagesDirText.enabled = false;
jsonPathText.enabled = false;
if (!cs2) helpButton.enabled = false;
runButton.enabled = false;
cancelButton.enabled = false;
var rulerUnits = app.preferences.rulerUnits;
app.preferences.rulerUnits = Units.PIXELS;
try {
//var start = new Date().getTime();
run();
//alert((new Date().getTime() - start) / 1000 + "s");
} catch (e) {
if (e.message == "User cancelled the operation") return;
var layerMessage = lastLayerName ? "[layer " + lastLayerName + "] " : "";
alert("An unexpected error has occurred:\n\n" + layerMessage + "[line: " + e.line + "] " + e.message
+ "\n\nTo debug, run the PhotoshopToSpine script using Adobe ExtendScript with \"Debug > Do not break on guarded exceptions\" unchecked.\n\nv" + scriptVersion);
debugger;
} finally {
if (activeDocument != originalDoc) activeDocument.close(SaveOptions.DONOTSAVECHANGES);
app.preferences.rulerUnits = rulerUnits;
if (progress && progress.dialog) progress.dialog.close();
dialog.close();
}
};
dialog.center();
dialog.show();
}
function loadSettings () {
var options;
try {
options = app.getCustomOptions("PhotoshopToSpine");
} catch (ignored) {}
settings = {};
for (var key in defaultSettings) {
if (!defaultSettings.hasOwnProperty(key)) continue;
var typeID = sID(key);
if (options && options.hasKey(typeID))
settings[key] = options["get" + getOptionType(defaultSettings[key])](typeID);
else
settings[key] = defaultSettings[key];
}
}
function saveSettings () {
if (cs2) return; // No putCustomOptions.
var desc = new ActionDescriptor();
for (var key in defaultSettings) {
if (!defaultSettings.hasOwnProperty(key)) continue;
desc["put" + getOptionType(defaultSettings[key])](sID(key), settings[key]);
}
app.putCustomOptions("PhotoshopToSpine", desc, true);
}
function getOptionType (value) {
switch (typeof(value)) {
case "boolean": return "Boolean";
case "string": return "String";
case "number": return "Double";
};
throw new Error("Invalid default setting: " + value);
}
// Help dialog.
function showHelpDialog () {
var dialog = new Window("dialog", "PhotoshopToSpine - Help");
dialog.alignChildren = ["fill", ""];
dialog.orientation = "column";
dialog.alignment = ["", "top"];
var helpText = dialog.add("statictext", undefined, ""
+ "This script writes layers as images and creates a JSON file to bring the images into Spine with the same positions and draw order they had in Photoshop.\n"
+ "\n"
+ "The Photoshop ruler origin corresponds to 0,0 in Spine.\n"
+ "\n"
+ "Tags in square brackets can be used anywhere in layer and group names to customize the output. If \":name\" is omitted, the layer or group name is used.\n"
+ "\n"
+ "Group and layer names:\n"
+ "• [bone] or [bone:name] Layers, slots, and bones are placed under a bone. The bone is created at the center of a visible layer. Bone groups can be nested.\n"
+ "• [slot] or [slot:name] Layers are placed in a slot.\n"
+ "• [skin] or [skin:name] Layers are placed in a skin. Skin layer images are output in a subfolder for the skin.\n"
+ "• [scale:number] Layers are scaled. Their attachments are scaled inversely, so they appear the same size in Spine.\n"
+ "• [folder] or [folder:name] Layer images are output in a subfolder. Folder groups can be nested.\n"
+ "• [overlay] This layer is used as a clipping mask for all layers below.\n"
+ "• [trim] or [trim:false] Force this layer to be whitespace trimmed or not.\n"
+ "• [mesh] or [mesh:name] Layer is a mesh or, when a name is specified, a linked mesh.\n"
+ "• [ignore] Layers, groups, and any child groups will not be output.\n"
+ "\n"
+ "Group names:\n"
+ "• [merge] Layers in the group are merged and a single image is output.\n"
+ "• [name:pattern] Adds a prefix or suffix to layer names in the group. The pattern must contain an asterisk (*).\n"
+ "\n"
+ "Layer names:\n"
+ "• The layer name is used for the attachment or skin placeholder name, relative to any parent [skin] or [folder] groups. Can contain / for subfolders.\n"
+ "• [path:name] Specifies the image file name, if it needs to be different from the attachment name. Can be used on a group with [merge].\n"
+ "\n"
+ "If a layer name, folder name, or path name starts with / then parent layers won't affect the name."
, {multiline: true});
helpText.preferredSize.width = 325;
var closeButton = dialog.add("button", undefined, "Close");
closeButton.alignment = ["center", ""];
closeButton.onClick = function () {
dialog.close();
};
dialog.center();
dialog.show();
}
// Progress dialog:
function showProgress (title, total) {
title = title ? "PhotoshopToSpine - " + title : "PhotoshopToSpine";
if (!progress) {
var dialog = new Window("palette", title);
dialog.alignChildren = "fill";
dialog.orientation = "column";
var message = dialog.add("statictext", undefined, "Initializing...");
var group = dialog.add("group");
var bar = group.add("progressbar");
bar.preferredSize = [300, 16];
bar.maxvalue = total;
bar.value = 1;
var cancelButton = group.add("button", undefined, "Cancel");
cancelButton.onClick = function () {
cancel = true;
cancelButton.enabled = false;
return;
};
dialog.center();
dialog.show();
dialog.active = true;
progress = {
dialog: dialog,
bar: bar,
message: message
};
} else {
progress.dialog.text = title;
progress.bar.maxvalue = total;
}
progress.count = 0;
progress.total = total;
progress.updateTime = 0;
var reset = $.hiresTimer;
}
function incrProgress (layerName) {
lastLayerName = trim(layerName);
progress.count++;
if (progress.count != 1 && progress.count < progress.total) {
progress.updateTime += $.hiresTimer;
if (progress.updateTime < 500000) return;
progress.updateTime = 0;
}
progress.bar.value = progress.count;
progress.message.text = progress.count + " / "+ progress.total + ": " + lastLayerName;
if (!progress.dialog.active) progress.dialog.active = true;
}
// PhotoshopToSpine utility:
function initializeLayers (context, selectedLayers, parent, parentLayers) {
while (context.index >= context.first) {
if (cancel) return -1;
var id = getLayerID(context.index--);
var selected = parent && parent.selected;
if (selectedLayers && !selected) {
for (var i = 0, n = selectedLayers.length; i < n; i++) {
if (selectedLayers[i] === id) {
selected = true;
break;
}
}
}
var layer = new Layer(id, parent, selected);
if (layer.isGroupEnd) break;
context.total++;
parentLayers.push(layer);
if (layer.isGroup) initializeLayers(context, selectedLayers, layer, layer.layers);
}
}
function collectLayers (parentLayers, collect, overlays) {
outer:
for (var i = 0, n = parentLayers.length; i < n; i++) {
if (cancel) return;
var layer = parentLayers[i];
incrProgress(layer.name);
if (settings.selectionOnly && !layer.selected) {
var needsMerge = layer.isGroup && (layer.findTagLayer("merge") || layer.findTagLayer("overlay"));
if (!needsMerge && layer.layers && layer.layers.length > 0)
collectLayers(layer.layers, collect, overlays);