@spec adaptive_icon_xml() :: String.t()

Returns the XML body for mipmap-anydpi-v26/ic_launcher.xml.

Uses @mipmap/ic_launcher_foreground for the foreground and @color/ic_launcher_background for the background.

@spec adaptive_sizes() :: %{required(String.t()) => pos_integer()}

Returns the map of Android mipmap bucket names to pixel dimensions for adaptive-icon foreground layers (108×108 dp scaled per density).

@spec android_sizes() :: %{required(String.t()) => pos_integer()}

Returns the map of Android mipmap bucket names to pixel dimensions for legacy (single-layer) icons.

@spec background_color_xml(String.t()) :: String.t()

Returns the XML body for values/ic_launcher_background.xml defining the adaptive icon background colour.

Accepts hex strings with or without a leading # (case-insensitive). Raises ArgumentError for non-hex input.

@spec generate_adaptive(
  source_path :: String.t(),
  output_dir :: String.t(),
  keyword()
) :: :ok

Generates adaptive Android icons from a source image.

Writes:

• mipmap-anydpi-v26/ic_launcher.xml + ic_launcher_round.xml referencing @mipmap/ic_launcher_foreground and @color/ic_launcher_background
• mipmap-<bucket>/ic_launcher_foreground.png at the adaptive icon canvas size for each density bucket
• values/ic_launcher_background.xml defining the background color

Options

• :background_color — hex string like "#E8B53C". If absent, sampled from the source image at top-centre (10% from the top).

Legacy ic_launcher.png/ic_launcher_round.png are written separately by generate_from_source/2 for older Android versions.

@spec generate_from_source(
  source_path :: String.t(),
  output_dir :: String.t(),
  keyword()
) :: :ok

Resizes an existing image at source_path to the icon sizes of each platform the project has (platforms/1), writing them into output_dir.

Options

• :background_color — hex string like "#E8B53C" used to flatten the iOS icons (which must be opaque — Apple rejects any alpha channel on the App Store marketing icon, error 90717). Android icons keep their transparency. If absent, the colour is sampled from the source (same as the adaptive-icon background), so the two platforms stay consistent.

Returns :ok.

@spec generate_random(
  output_dir :: String.t(),
  keyword()
) :: :ok

Generates a random robot avatar and writes platform icons into output_dir.

Creates, for each platform the project has (platforms/1):

• output_dir/android/app/src/main/res/<bucket>/ic_launcher.png for each Android bucket
• output_dir/ios/Assets.xcassets/AppIcon.appiconset/icon_<px>.png for each iOS size
• output_dir/icon_source.png — the 1024×1024 master

Returns :ok on success.

@spec ios_sizes() :: [pos_integer()]

Returns the list of iOS icon pixel dimensions.

@spec platforms(String.t()) :: [:android | :ios]

The platforms whose native project exists in project_dir (android/, ios/). Icons are written only for these, so an --android project never grows an ios/Assets.xcassets tree (and vice versa).

@spec platforms_missing_icons(String.t()) :: [:android | :ios]

The project's platforms that have no launcher icon yet. mix mob.install writes its placeholder only to these, leaving existing (possibly custom) icons alone.

@spec use_mob_logo(output_dir :: String.t(), [:android | :ios]) :: :ok

Copies the bundled Mob logo (pre-built PNGs) to the icon directories of platforms (default: every platform the project has, platforms/1). Used as the default placeholder icon by mix mob.install. No extra dependencies or system tools required.

Returns :ok.