图标精灵配置文件

如果您需要自动创建所有应用程序的图标和启动画面，图标精灵提供可以批处理运行的配置文件。

这些配置文件称为“配置文件”。文件为 JSON 格式，告诉图标精灵要生成哪些图像以及如何生成。它们还可以免去您记住生成资产的所有图标精灵命令和参数的麻烦。

文件结构

JSON 配置文件的通用形式是

{
  "params": { },
  "assets": [ ]
}

我们将在接下来的部分中讨论每个部分。

参数

来自 JSON 配置文件的 params 对象采用与 generate 命令参数相同的属性名称（但使用驼峰命名法而不是 CLI 的短横线命名法）。有一个关键区别：您将编写 include（例如：[ "spa", "pwa" ]，[ "all" ]），而不是使用 mode（例如：“spa,pwa”，“all”）。

您可以为 params 对象编写的属性的完整列表

属性名	类型	描述	示例
include	数组	包括图标精灵为特定 Quasar 模式硬编码的资产集	`[ "spa", "pwa" ]` / `[ "all" ]`
icon	字符串	图标源文件的路径；可以是相对于 Quasar 项目文件夹根目录的绝对路径或相对路径	`my-icon.png`
background	字符串	可选背景源文件的路径（用于启动画面）；可以是相对于 Quasar 项目文件夹根目录的绝对路径或相对路径	`my-bg.png`
filter	字符串	可选地按生成器过滤资产；使用时，它可以只生成一种类型的资产，而不是所有类型	`ico`
quality	数字 [1-12]	生成文件的质量；质量越高，文件大小越大，速度越慢；质量越低，文件大小越小，速度越快	`12`
padding	数组 [数字]	(v2.1+) 在修剪图标图像后应用固定填充；语法：`[ <horiz_px>, <vert_px> ]`；默认值为：`[0, 0]`	`[10, 0]` / `[5,5]`
skipTrim	布尔值	(v2.2+) 不要修剪图标源文件
themeColor	字符串 [十六进制]	所有需要颜色的生成器使用的主题颜色；如果指定了任何生成器颜色，它将被覆盖	`ccc` / `e2b399`
pngColor	字符串 [十六进制]	当资产定义中的 “background: true”（如 Cordova/Capacitor iOS 图标）时，用于 png 生成器的背景颜色	`ccc` / `e2b399`
splashscreenColor	字符串 [十六进制]	用于启动画面生成器的背景颜色	`ccc` / `e2b399`
svgColor	字符串 [十六进制]	用于生成的单色 SVG 的颜色	`ccc` / `e2b399`
splashscreenIconRatio	数字 [0-100]	图标大小相对于结果启动画面宽度或高度（以较小者为准）的比率；表示百分比；0 表示它不会在背景顶部添加图标	`40`

资产

assets 数组可以包含对 **额外资产** 的自定义定义，如果您需要。当图标精灵的每个模式的默认列表不足以满足您的使用情况时，可以使用它。如果您没有在 params 中指定 include 属性，您只能生成自定义资产。

在 99% 的情况下，您不需要指定 assets 数组，但图标精灵的设计非常灵活，因此它也包含此功能。

一些 assets 的示例，您可以从中提取图标精灵可以生成的每种可能的资产的语法

"assets": [
  {
    "generator": "png",
    "name": "icon-{size}x{size}.png",
    "folder": "src-bex/icons",
    "sizes": [ 16, 48, 128 ]
  },

  {
    "generator": "svg",
    "name": "safari-pinned-tab.svg",
    "folder": "public/icons"
  },

  {
    "generator": "splashscreen",
    "name": "apple-launch-{size}.png",
    "folder": "public/icons",
    "sizes": [
      [ 1668, 2388 ]
    ],
    "tag": "<link rel=\"apple-touch-startup-image\" media=\"(device-width: 1024px) and (device-height: 1366px) and (-webkit-device-pixel-ratio: 2)\" href=\"icons/{name}\">"
  },

  {
    "generator": "icns",
    "name": "icon.icns",
    "folder": "src-electron/icons"
  },

  {
    "generator": "ico",
    "name": "icon.ico",
    "folder": "src-electron/icons"
  },

  {
    "generator": "splashscreen",
    "name": "Default-Landscape-2436h.png",
    "folder": "src-cordova/res/screen/ios",
    "sizes": [
      [ 2436, 1125 ]
    ]
  },

  {
    "generator": "png",
    "name": "[email protected]",
    "folder": "src-cordova/res/ios",
    "sizes": [ 58 ],
    "platform": "cordova-ios",
    "background": true
  },

  {
    "generator": "png",
    "name": "[email protected]",
    "folder": "src-cordova/res/ios",
    "sizes": [ 58 ],
    "platform": "cordova-ios",
    "background": true
  },

  {
    "generator": "png",
    "name": "xxxhdpi.png",
    "folder": "src-cordova/res/android",
    "sizes": [ 192 ],
    "platform": "cordova-android",
    "density": "xxxhdpi"
  },

  {
    "generator": "splashscreen",
    "name": "Default@2x~ipad~comany.png",
    "folder": "src-cordova/res/screen/ios",
    "sizes": [
      [ 1278, 2732 ]
    ],
    "platform": "cordova-ios"
  },

  {
    "generator": "splashscreen",
    "name": "splash-land-xxxhdpi.png",
    "folder": "src-cordova/res/screen/android",
    "sizes": [
      [ 1920, 1280 ]
    ],
    "platform": "cordova-android",
    "density": "land-xxxhdpi"
  }
]

引导配置文件

图标精灵还提供 profile 命令，它可以为您引导 JSON 配置文件。它可以帮助您创建一个或多个此类文件，然后您可以通过 generate 命令使用 --profile 参数（或简写 -p）批量运行它们。

最方便的用例是将多个配置文件生成到一个特定文件夹中，每个配置文件都有自己的参数，然后通过 $ icongenie generate -p /path/to/folder 运行它们。

发现错误了吗？在浏览器中编辑此页面

1. 简介

2. 文件结构

2.1. 参数

2.2. 资产

3. 引导配置文件