APPIcon（自留）

Listing 2  Example configuration for a universal app with deployment target of iOS 5.0 or greater.

Troubleshooting

This section describes common problems and how to fix them.

My application fails to validate

There are multiple icon-related problems that will result in your application failing validation by Xcode or iTunes Connect. The underlying issue depends upon the error.

Error: Invalid Image Path

Your application&＃39;s information property list references one or more icon images that were not included in the compiled bundle.

If your application is using asset catalogs to manage its icons then the information property list should not include any icon related keys; they will be added at build time by the asset catalog compiler.

1. Open the information property list for your app&＃39;s target. It can be found under the Info tab in the project editor or in the File Navigator where it will be named either 

   -Info.plist or Info.plist, where 

    is the name of your app.

2. Remove the following keys, including device specific variations.

   • “Icon file” (CFBundleIconFile)

   • “Icon files” (CFBundleIconFiles)

   • CFBundleIcons

If your application is not using asset catalogs to manage its icons, one or more of the images listed under the CFBundleIconFiles key or the CFBundleIcons key in the information property list is not associated as a resource of your application, may not have been added to your project, or may have been accidentally removed from your project. Verify that all the images named by either of these keys is included in your project then follow the resolution steps listed under My icons don&＃39;t appear on the device to verify that it is associated with your application.

Error: Missing required icon file

Your have not included artwork for one or more of the required icons, based on your app&＃39;s supported devices and deployment target.

Refer to the tables above for the list of required icons. Verify that each of your icon images matches the size listed in the table.

If your application is not using asset catalogs to manage its icons, verify that all of your icon images are listed under the CFBundleIconFiles key or the CFBundleIcons key as described inConfiguring Icons Without an Asset Catalog. Remember that if you include filename extensions in the Information Property List, you must specify all image files (including the high-resolution variants) explicitly.

My icons don&＃39;t appear on the device

If your project is using asset catalogs, your application may not be configured to use the correct icon set.

1. Select the name of the project in the project navigator.

2. Select the name of a target from the list in the left column of the project editor.

3. Select the General tab at the top of the project editor.

4. Verify that the name of the app icon set is selected in the Source menu under the App Icons section, as shown in Figure 5.

If your project is not using asset catalogs to manage its icons, one or more of your icon images may not be associated with your app&＃39;s target.

1. Select each of your icon images in the project navigator.

2. In the utility panel, check the box next to your app&＃39;s target under the Target Membership pane as shown in Figure 6.

Verify that your icon images use a supported color model. Images that do not use the RGB color model may appear correctly in Xcode but will fail to load on the device. If your icons include transparent areas, use your preferred graphics editing software to fill these areas with a solid color.

Some graphics software may produce images which load correctly in Xcode but fail to load on the device, resulting in a blank icon. Try exporting your icon images with a different graphics editor such as the built in Preview app.

A previous version of my icon appears on the device

Your testing device or simulator may have a partially outdated build. That is, Xcode failed to copy a modified resource to the app bundle it installed on the device as part of the build & run process. To force Xcode to copy the most recent resources from your project directory:

1. Remove the app from your testing device or simulator.

2. Clean the build directory. Hold down the Option key and choose Product > Clean Build Folder, then Product > Build from the Xcode menu bar

3. Build and run your app.

If your project is using asset catalogs then you must replace the modified image in the asset catalog. Asset catalogs do not track files on disk, opting instead to make a copy of the image at the time it is added to the asset catalog.

My icon has a black background in the App Store

The Large App Icon you uploaded to iTunes Connect includes transparent areas. The iTunes Connect Developer Guide lists the complete requirements for the Large App Icon, including that it must be opaque.

You can use the Preview app to check your image for transparent areas, which will appear dark grey as shown in Figure 7. Use your preferred graphics editing software to fill in the transparent areas with the desired background color.

The wrong icon appears in the App Store

Your application bundle includes additional images which are being detected as valid icon images.

You may encounter this issue if your icon images deviate from the naming convention shown in the above tables. If your application bundle also contains once or more images that match the naming convention in the tables above, these images may be detected as valid icon images by the App Store. This may occur regardless of whether those images are included in the asset catalog or are referenced by the application&＃39;s Information Property List. The solution is to rename or remove the images.

You may encounter this issue when building an app using a third party development environment or if your project was created using a template project provided by a third party. Both will usually include a default set of icon images. If you fail to remove these images or replace all of them with your own artwork, the App Store may display them in the search results for your app. Like the iOS home screen, the icons displayed in the search results depend upon the current device. It is possible that the incorrect icon is shown in the search results on certain devices but not others.

The solution is to delete any instances of the template-provided icons that remain in your project and remove any references to the deleted files from the information property list. Due to the wide variety of ways in which iOS versions have allowed developers to specify app icons in the Information Property List, you may find it simpler and less error prone to remove all icon related keys from the Information Property List and then reconfigure your app&＃39;s icons using the steps presented in Adding Icons to Your App. See Start Over.

Start Over

If the none of the above solutions resolve the problem, follow the steps below to remove all the icons and icon related configuration from your app. Then follow the steps in Adding Icons to Your App to re-configure the proper icons for your app.

Remove the Icon Set From Your Asset Catalog

1. Select the asset catalog in the project navigator. It is named Images.xcassets by default.

2. In the left column of the editor, control click the icon set and choose Remove Selected Items from the context menu. By default the icon set will be named &＃39;AppIcon&＃39;.

Remove Icon Images From Your Project

Using the Xcode file navigator, remove any icon images from your project your had previously added to your project as resources. Icon images usually have a file name beginning with &＃39;Icon&＃39; or &＃39;AppIcon&＃39;.

Remove Icon Related Keys From The Information Property List

1. Open the Information Property List for your application. It can be found under the Info tab in the project editor or in the navigator where it will be named either YourApp-Info.plist orInfo.plist.

2. Remove the following keys, including device specific variations.

   • “Icon file” (CFBundleIconFile)

   • “Icon files” (CFBundleIconFiles)

   • CFBundleIcons

Clean The Project

To remove any cached icons, clean your target. Choose Product > Clean from the menu bar.

Finally, follow the steps in Adding Icons to Your App to re-configure the proper icons for your app.

Additional Resources

For additional information, see the App Icons section in the iOS App Programming Guide.

For information about designing your application&＃39;s icons, see the App Icon section of the iOS Human Interface Guidelines.

For an example project with properly configured icons, see the Application Icons and Launch Images for iOS sample code.

Document Revision History