Localize your application

The Microsoft Game Configuration file allows you to define the provided localization support of your title

You can use the Shell Visuals section of the Microsoft Game Config asset Inspector window to:

  • configure supported languages
  • generate placeholder resources
  • generate the localization configuration files
  • build a Resource.Pri file using the MakePri.exe command line tool

Shell Visuals resources consist of language locale pairs and a selection of .png images, such as a title splash screen or logo. Each title must include Shell Visuals resources and a Resources.Pri file for the Microsoft Game Store localization to work.

Build Shell Visuals resources

To build the Shell Visuals resources, use the following steps:

  1. Create a folder to store your Microsoft Game Config and Shell Visual resources.
  2. Create a new Microsoft Game Config file in this folder. Right click in the folder and select Create > GDK > Microsoft Game Config.
    • Although not mandatory, it’s recommended that you create your Microsoft Game Config asset inside the same folder that contains the Shell Visuals resources. This is the same default layout as used by the MicrosoftGame.Config Editor and reduces the chances of errors in that tool or with MakePri.exe.
  3. Select the Microsoft Game Config asset. In the Inspector window, expand the Shell Visuals section.
  4. Select the language pairs you want to support.
    • You can add more language pairs later, but you must update the resources. Removing languages doesn’t automatically delete resources. It must be done manually to avoid the accidental deletion of files.
  5. Verify that the Shell Visuals Resource Path and Built Resources Pri Path are correct. The default path is the folder in which the MGC asset is created. These paths must be set before you can build the Shell Visuals Resources.pri file.
  6. Apply any changes made.
  7. Select Generate Shell Visuals Resources.
  8. For each missing shell resource, a dialog displays asking for permission to generate new placeholder image. Select yes to continue. The Microsoft Game Configuration file will be updated accordingly.
    • If you have selected language pairs, an additional dialog box appears, offering you to import the default images for all newly selected languages. Select yes to continue.
  9. Placeholder resources are generated in the folder specified by Shell Visuals Resource Path.
  10. Select Build Shell Visuals Resources (Resources.Pri). A Resources.Pri file is created in the folder specified by Built Resources Pri Path.
  11. Update the placeholder images and resources files per your requirements. Don’t change the file names unless you intend to maintain the MakePri.exe configuration files yourself.

When you update Shell Visuals Resources, existing image files aren't affected or deleted. This is intended to avoid accidental loss of existing image resources as a result of changing the Language Pairs. However, the MakePri configuration files are updated to reflect the current configuration.

Any changes to Language Pair Resources are reflected in the MicrosoftGame.Config only when selecting Apply. However, changes aren't automatically applied to associated Shell Visual resources in the Assets folder. You must manually select Generate Shell Visuals Resources or Update Shell Visuals Resources to apply these changes.

Additional resources