Figma To Unity Importer 技术文档

1. 安装指南

1.1 通过Package Manager安装

1. 打开Unity编辑器，进入Window > Package Manager。
2. 点击左上角的+按钮，选择Add package from git URL...。
3. 输入以下URL：

   https://github.com/ManakhovN/FigmaToUnityImporter.git?path=/Assets/FigmaImporter
   

4. 点击Add按钮，等待安装完成。

2. 项目的使用说明

2.1 导入FigmaImporter

1. 安装完成后，将FigmaImporter导入到你的项目中。
2. 导入后，Unity编辑器中会出现一个新的菜单选项。

2.2 获取Figma访问权限

1. 在Unity编辑器中，点击OpenOauthUrl按钮。
2. 浏览器会跳转到Figma的访问授权页面，点击Allow access。
3. 授权成功后，浏览器会打开一个回调页面，复制页面中的ClientCode和State。
4. 回到Unity编辑器，将复制的ClientCode和State粘贴到Figma编辑器窗口中，点击GetToken按钮。
5. 如果成功获取到Token，说明操作正确。如果未成功，请重复授权步骤。

2.3 导入Figma节点

1. 在Figma中复制节点链接，粘贴到Unity编辑器中的URL字段。
2. 在Unity编辑器中选择一个Canvas，并点击Get Node Data按钮，加载节点及其子节点的数据。
3. 选择每个子节点的操作方式：
   • Generate：尝试通过UGUI生成节点。
   • Render：通过Figma API加载节点的渲染图像。
   • Transform：仅设置生成对象的变换。
   • None：不执行任何操作。
4. 点击Generate nodes按钮，生成节点到指定的Canvas中。

2.4 其他功能

• To generate：默认行为，将节点渲染为栅格图像，生成包含子节点的节点，生成文本节点。
• To Transform：将所有节点的操作设置为Transform，适用于对现有对象应用更改。
• To SVG：如果安装了Unity的Vector Graphics包，尝试将所有图像加载为SVG。

2.5 字体处理

如果遇到字体错误，需要在FontLinks.asset脚本化对象中添加字体。

3. 项目API使用文档

3.1 获取Figma节点数据

• API: GetNodeData(string nodeUrl, Canvas targetCanvas)
• 描述: 通过Figma节点链接获取节点数据，并加载到指定的Canvas中。
• 参数:
  • nodeUrl: Figma节点的URL。
  • targetCanvas: 目标Canvas对象。
• 返回值: 无。

3.2 生成节点

• API: GenerateNodes(Canvas targetCanvas)
• 描述: 根据当前设置生成节点到指定的Canvas中。
• 参数:
  • targetCanvas: 目标Canvas对象。
• 返回值: 无。

3.3 设置节点操作

• API: SetNodeAction(NodeAction action)
• 描述: 设置所有节点的操作方式。
• 参数:
  • action: 节点操作方式，可选值为Generate, Render, Transform, None。
• 返回值: 无。

4. 项目安装方式

4.1 通过Package Manager安装

如前所述，通过Unity的Package Manager安装Figma To Unity Importer。

4.2 手动安装

1. 从GitHub仓库下载项目文件。
2. 将Assets/FigmaImporter文件夹复制到你的Unity项目中。
3. 在Unity编辑器中刷新项目，即可使用。

---

通过以上步骤，你可以顺利安装并使用Figma To Unity Importer工具，将Figma中的设计元素导入到Unity项目中。