csb2csd

cocostudio csb反编成csd

建完工程搜了遍才发现已经有大佬实现了csb2csd。可惜在windows系统折腾了几遍竟然没法编译成功(linux上一遍过了)。还是决定自己手撸一个好了。

使用说明

1. 处理一个csb文件，运行python convert.py <csb_file_in> <csd_file_out>，执行后会生成对应的csd文件。

2. 处理整个目录，运行python convert.py <dir_in> <dir_out>，执行后目录中的csb文件会反编译成csd文件，其他类型文件原封不动复制到新的路径下。

如遇到转换过程报错或转换后格式错误的，欢迎反馈并尽量提供源文件。

配置相关

1. CSParseBinary.fbs 是基于cocos/editor-support/cocostudio/fbs-files/CSParseBinary.fbs，添加了一些其他结构，使用flatc -p CSParseBinary.fbs生成库结构，部分坑需要手动修改

2. header_rule.json和child_rule.json是导出csd的规则配置，其中header_rule.json是对应csd中类似<AbstractNodeData Name="room_bg" ActionTag="-1313931908" Tag="1" ...这样的格式，child_rule.json对应<AnchorPoint ScaleX="0.5" ScaleY="0.5" />的格式

   2.1 header_rule.json 以Button为例,

配置
"Button":[
		["DisplayState", "Displaystate", false, ""],
		["Scale9Enable", "Scale9Enabled", false, ""],
		["LeftEage", "CapInsets.X", 0.0, ""],
		["RightEage", "CapInsets.X", 0.0, ""],
		["TopEage", "CapInsets.Y", 0.0, ""],
		["BottomEage", "CapInsets.Y", 0.0, ""],
		["Scale9OriginX", "CapInsets.X", 0.0, ""],
		["Scale9OriginY", "CapInsets.Y", 0.0, ""],
		["Scale9Width", "CapInsets.Width", 0.0, ""],
		["Scale9Height", "CapInsets.Height", 0.0, ""],
		["ShadowOffsetX", "ShadowOffsetX", 0.0, ""],
		["ShadowOffsetY", "ShadowOffsetY", 0.0, ""],
		["ButtonText", "Text", "", ""],
		["FontSize", "FontSize", "", ""]
	],

对应csd结构
<AbstractNodeData ... DisplayState="True" Scale9Enable="True" LeftEage="15" RightEage="15" 
   TopEage="11" BottomEage="11" Scale9OriginX="15" Scale9OriginY="11" Scale9Width="1" Scale9Height="9" 
   ShadowOffsetX="2" ShadowOffsetY="-2" ButtonText="Test" FontSize="14">

fbs结构
   table ButtonOptions
   {
       widgetOptions:WidgetOptions;

       normalData:ResourceData;
       pressedData:ResourceData;
       disabledData:ResourceData;
       fontResource:ResourceData;
       text:string;
       fontName:string;
       fontSize:int;
       textColor:Color;
       capInsets:CapInsets;
       scale9Size:FlatSize;
       scale9Enabled:bool;
       displaystate:bool;

       outlineEnabled:bool = false;
       outlineColor:Color;
       outlineSize:int = 1;
       shadowEnabled:bool = false;
       shadowColor:Color;
       shadowOffsetX:float = 2;
       shadowOffsetY:float = -2;
       shadowBlurRadius:int;
       isLocalized:bool = false;
   }

["Scale9OriginY", "CapInsets.Y", 0.0, ""]第一个为csd的字段名，第二个为根据fbs取值的字段路径, 第三个为默认值，等于默认值的将不写到csd中，第四个为重命名，如["ProgressType", "Direction", 0, "0=Left_To_Right,1=Right_To_Left"]就是值为0时，写入csd的是Left_To_Right，1时写入Right_To_Left

2.2 child_rule.json 跟2.1类似

<Size X="100" Y="100" />

struct FlatSize
{
    width:float;
    height:float;
}

["Size", "Size", "X=Width,Y=Height", ""], 第一个为csd的字段名，第二个为根据fbs取值的字段路径, 第三个为重命名，即将width的值以键X写入csd，第四个为特殊标记，不赋值的时候会按照fbs的字段格式导出，特殊值目前只有ImageData,代表这是文件路径格式

待完成

1. 支持粒子特效、骨骼动画
2. 支持动画曲线的points
3. ……

踩过的坑

1. 对比引擎用的CSParseBinary_generated.h和给出的CSParseBinary.fbs，发现fbs中的isLocalized位置有问题需要手动移至最后

2. 九宫格数据Scale9OriginX，Scale9OriginY，Scale9Width，Scale9Height必须是整数否则会解析错误，取出的浮点数要去除小数点和0

3. 编辑器里显示的九宫格用的是LeftEage、RightEage、TopEage、BottomEage，而不是2中的几个字段

4. 字段名不一致容易写错的：

   fbs字段名	编辑器字段
   ClipEnabled	ClipAble
   Scale9Enabled	Scale9Enable
   TouchScaleEnable	TouchScaleChangeAble

5. flatc导出python时bool类型的默认值未生效，默认值全部都是false，一些默认值为true的会有问题，已手动修改

6. 骨骼动画、粒子特效的结构描述竟然不在CSParseBinary.fbs里面，暂只整合进了SketonNode