【Cocos2d-x】 一个简单的将plist分割为原图的命令行工具

原创作品，转载请标明：http://blog.csdn.net/xiejingfa/article/details/48023345

缘起

在学习Cocos2d-x时，经常需要到网上下载一些游戏实例。很多源码中的图片资源都是经过Texture Packer打包过的plist文件而没有提供单个的原图片文件。于是我就想着写一个脚本把打包好的plist文件和对应的png图片分割为原来的小图片，网上也有很多用Python实现的脚本。在这个我利用argparse和PIL制作了一个简易的命令行工具。

原理

由于plist文件本质上是基于xm的文本格式，里面记录了原始图片文件的名称、尺寸大小和位置信息。利用ElementTree从xml解析出上述信息，然后利用PIL把原始文件切割出来就可以得到单个的原始文件。argparse主要用来处理命令行信息。

源码如下，比较简单，这里就不一一解释：

# -*- coding:utf-8 -*-
"""
    This utility is used to parse plist file which is packed by Texture Packer to original images.
    usage:
        -plist specify the path of plist file(required parameter).
        -png specify the path of png file(required parameter).
        -dir specify a output directory(optional). By default, it will make a new directory named
             with plist filename in current directory to save images.
"""

from xml.etree import ElementTree
from PIL import Image
import argparse
import os
import sys


class PlistParser(object):

    # initializer
    def __init__(self, plist, png_image, output_dir):
        self.plist_file = plist
        self.png_file = png_image
        self.atlas_dir = output_dir

    # convert a xml tree to dict.
    def convert_tree_to_dict(self, tree):
        d = {}
        for index, item in enumerate(tree):
            if item.tag == 'key':
                if tree[index + 1].tag == 'string':
                    d[item.text] = tree[index + 1].text
                elif tree[index + 1].tag == 'true':
                    d[item.text] = True
                elif tree[index + 1].tag == 'false':
                    d[item.text] = False
                elif tree[index + 1].tag == 'dict':
                    d[item.text] = self.convert_tree_to_dict(tree[index + 1])
        return d

    # split png file into individual images.
    def split_png_from_plist(self):
        # generate output directory.
        target_file_dir = self.atlas_dir;
        if target_file_dir is None:
            target_file_dir = plist_filename.replace('.plist', '')
            if not os.path.isdir(target_file_dir):
                os.mkdir(target_file_dir)

        # open the source image.
        src_image = Image.open(png_filename)
        plist_content = open(plist_filename, 'r').read()
        plist_root = ElementTree.fromstring(plist_content)
        plist_dict = self.convert_tree_to_dict(plist_root[0])

        to_list = lambda x : x.replace('{', '').replace('}', '').split(',')
        for k, v in plist_dict['frames'].items():
            pos_str = str(v['frame'])
            rect_list = to_list(pos_str)
            width = int( rect_list[3] if v['rotated'] else rect_list[2] )
            height = int(rect_list[2] if v['rotated'] else rect_list[3] )
            bounding_box = (
                int(rect_list[0]),
                int(rect_list[1]),
                int(rect_list[0]) + width,
                int(rect_list[1]) + height,
            )
            size_list = [ int(x) for x in to_list(v['sourceSize']) ]

            rect_image = src_image.crop(bounding_box)
            if v['rotated']:
                rect_image = rect_image.rotate(90)

            outfile = os.path.join(target_file_dir, k)
            rect_image.save(outfile)


if __name__ == '__main__':
    # register all available parameters.
    parser = argparse.ArgumentParser(usage='please use unpacker.py -h to get usage information.')
    parser.add_argument('-plist', help='Specify the path of plist file.', type=str)
    parser.add_argument('-png', help='Specify the path of png file.', type=str)
    parser.add_argument('-dir', help='Specify a output directory.', type=str)

    # get parameters.
    args = parser.parse_args()
    plist_filename = args.plist
    png_filename = args.png
    output_dir = args.dir

    # test whether the file/dir is None
    if plist_filename is None:
        print 'make sure to use -plist to specify the plist file path.'
        sys.exit(1)
    if png_filename is None:
        print 'make sure to use -png to specify the source png image.'
        sys.exit(1)

    # test whether the file/dir exits
    if not os.path.exists(plist_filename):
        print 'error: plist file doesn\'t exist.'
        sys.exit(1)
    if not os.path.exists(png_filename):
        print 'error: png file doesn\'t exist.'
        sys.exit(1)
    if output_dir is not None and not os.path.isdir(output_dir):
        print 'error: %s is no an valid directory or doesn\'t exist.' % output_dir
        sys.exit(1)

    plist_parser = PlistParser(plist_filename, png_filename, output_dir)
    plist_parser.split_png_from_plist()
    print 'success.'

使用方法

这个小工具提供了三个参数选项：-plist、-png、dir，他们的作用是：

-plist：用于指定plist的文件所在路径

-png：用于指定plist对于的png图片所在路径

  -dir：用于指出分割后得到的原始图片的输出目录。如果没有指定，默认情况下会在plist文件所在目录下新建一个与plist文件同名的文件夹用于存放图片

比如：我的plist文件存放在C:\Users\Administrator\Desktop\test\atlas.plist，对应的png图片存放在C:\Users\Administrator\Desktop\test\atlas.png。使用命令

                   

解析成功后就会在C:\Users\Administrator\Desktop\test\atlas得到相应的原始图片。

代码已经上传到GitHub：https://github.com/xiejingfa/unpacker