Cordova for Windows Build Options

The Intel® XDK Cordova build system automatically generates special configuration files in your project source directory to direct the build process. The Cordova build option is based on the open source Apache* Cordova CLI build system. When you use the Cordova build option your application project files are submitted to the Intel XDK cloud-based build server where a Cordova CLI system is hosted and maintained, there is no need to install the open source Cordova CLI system on your workstation.

The build configuration files is automatically generated based on input you provide on the Projects tab. The options described below can be use inside the intelxdk.config.additions.xml file to exercise finer grained control over the Projects tab options or to configure features that are not handled by the Projects tab.

The following build options pertain only to Windows builds. They will not affect builds for other target platforms. You can include these options in your intelxdk.config.additions.xml file when submitting a build, in order to either supplement or replace those options that are automatically generated by the Intel XDK.

For detailed information regarding the structure and contents of the intelxdk.config.additions.xml file, please read Understanding the Intel XDK Cordova Build File Options topic.

Windows Icon and Splash Screen Specifications

If no icon or splash screen files are provided with your project, the build system will provide defaults. You must provide the image sizes shown in bold in the table below, before submitting your application to the Windows Store; non-bold images are optional. If you do not provide unique images for your app your application may be rejected by Microsoft.

Beginning with Cordova CLI 5, icon and splash screen images must be provided in PNG format, other image formats will result in build errors.

Height and width numbers in the table are in pixels.

Your application will display a splash screen during initialization. This is done to provide a "getting ready" indication while your app and the underlying device API infrastructure initializes. If no splash files are provided with your project, the build system will provide default images. It is highly recommended that you include the 100% scale image splash screen prior to submitting the application to the app store.

See Guidelines for tile and icon assets and Publish Windows apps for more information.

Windows Build Preferences


The publisher ID string, assigned by Microsoft, is unique and identifies your Windows Store developer account when you submit your app to the Windows Store.

<preference name="windows-publisher-id" value="<PUBID>" />
<PUBID> is the publisher id assigned to you by Microsoft.

Preference windows-publisher-display-name (from the Windows 8 build instructions) has been deprecated in favor of the Cordova Preference WindowsStoreIdentityName. Providing either will produce the same effect. The publisher display name is the author name your apps are listed under in the Windows Store.

<preference name="windows-publisher-display-name" value="<DISPLAYNAME>" />
<DISPLAYNAME> represents the name under which your applications will be listed in the store.
This behaves differently from windows8-capability, which accepted only one capability value. To provide multiple capabilities you needed to use multiple windows8-capability tags. For Windows 10, however, there can be only one windows-capabilities tag; which holds all the capabilities in a single space-delimited string. Apps that need to call on user resources such as photos, camera, contacts, etc., must state the related capability the app will access. Upon submitting your app to the Windows Store, the declared capabilities are cross-checked to ensure they match the app description.
<preference name="windows-capabilities" value="<CAPABILITY_A> <CAPABILITY_B> <etc.>" />

Other considerations

Providing the preference windows-bundle-archs-separately (with any value string) will instruct the build system to create three separate appxupload files, one for each Windows architecture (x86, x64, arm). Some Windows builds will automatically produce three separate appxuploads, even if this preference is not provide. This will happen when bundling the three architectures into a single appxupload file fails.

For more complete information about compiler optimizations, see our Optimization Notice.