Python拆解plist图集

Python拆解plist图集

1. Plist简介

属性表文件(Plist)是一种文件形式，通常用于储存用户设置，也可以用于存储捆绑的信息，该功能在旧式的Mac OS中是由资源分支提供的。由于Plist中存储的数据是抽象的，其采用的文件格式可以不止一种。通常很多游戏引擎的图集，采用plist将小图进行打包到一个plist格式的图集.

2. Plist图集格式：

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple Computer//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
    <dict>
        <key>frames</key>
        <dict>
            <key>arrow_horizontal.png</key>
            <dict>
                <key>frame</key>
                <string>{{225,60},{56,56}}</string>
                <key>offset</key>
                <string>{0,0}</string>
                <key>rotated</key>
                <false/>
                <key>sourceColorRect</key>
                <string>{{0,0},{56,56}}</string>
                <key>sourceSize</key>
                <string>{56,56}</string>
            </dict>
        </dict>
        <key>metadata</key>
        <dict>
            <key>format</key>
            <integer>2</integer>
            <key>realTextureFileName</key>
            <string>BaseItems.png</string>
            <key>size</key>
            <string>{284,959}</string>
            <key>smartupdate</key>
            <string>$TexturePacker:SmartUpdate:1ae0323f4da5b460ae8f5a4460b3f98e:1/1$</string>
            <key>textureFileName</key>
            <string>BaseItems.png</string>
        </dict>
    </dict>
</plist>

图集中包含两个关键数据 frame和metadata, 其中frame中存放了每个子图的名称，在图集中的位置和大小,以及是否旋转(这里旋转知识垂直旋转，以使图集摆放比较紧凑)

3. Python使用的库:

• plistlib
  用于处理读取plist
• PIL
  处理图片，读取图集，切片，保存新图片

4. 代码：

"""
    功能: 将plist的图集拆分成单独的一个一个图片的脚本
    使用方法: 将脚本放置于含有plist和png图集的目录中, 用python3运行该脚本，则会在当前目录创建一个output目录，将图集拆分到output目录内
    使用前提下， 需要安装pip install PIL
"""

import plistlib
from PIL import Image
import os

def extract_images_from_plist(plist_path, output_dir):
    # 读取plist文件
    with open(plist_path, 'rb') as plist_file:
        plist_data = plistlib.load(plist_file)

    # 获取图集信息
    frames = plist_data['frames']

    # 读取原始图集图片
    atlas_image_path = plist_data['metadata']['textureFileName']
    atlas_image = Image.open(atlas_image_path)

    # 创建输出目录
    os.makedirs(output_dir, exist_ok=True)

    # 拆解图集并保存图片
    for frame_name, frame_info in frames.items():
        # 获取每个图块的位置和大小
        frame_rect = frame_info['frame']
        #print("frame_rect", frame_rect)
        frame_rect = frame_rect.replace('{', '')
        frame_rect = frame_rect.replace('}', '')
        x,y, width,height = map(int, frame_rect.split(','))

        # 获取旋转信息
        rotated = frame_info.get('rotated', False)

        # 裁剪图块
        image = atlas_image.crop((x, y, x + width, y + height))

        # 如果需要旋转，则逆时针旋转90度
        if rotated:
            image = atlas_image.crop((x, y, x + height, y + width))
            image = image.transpose(Image.Transpose.ROTATE_90)

        # 保存图块到输出目录
        output_path = os.path.join(output_dir, frame_name)
        image.save(output_path)

if __name__ == "__main__":

    plist_dir = "./"
    output_dir = "./output"

    if not os.path.exists(output_dir):
        os.mkdir(output_dir)

    for filename in os.listdir(plist_dir):
        if filename.endswith('.plist'):
            basename = os.path.basename(filename)
            basename = basename.split('.')[0]
            print(filename,basename)
            plist_path = os.path.join(plist_dir, filename)
            plist_output_path =os.path.join(output_dir, basename)
            if not os.path.exists(plist_output_path):
                os.mkdir(plist_output_path)
            print('extract image:', plist_path, plist_output_path)
            extract_images_from_plist(plist_path, plist_output_path)