Skip to content

Latest commit

 

History

History
110 lines (84 loc) · 4.29 KB

README.md

File metadata and controls

110 lines (84 loc) · 4.29 KB
Raw
page_type languages products description urlFragment
sample
cpp
dotnet
windows-uwp
Sample AddOn package for use in testing the Microsoft Partner Center.
sample-partner-center-apps-uwp-addon

Sample AddOn Project for Partner Center

The UwpAddOn project is a sample app to use as a package for an AddOn for an App or Game in Microsoft Partner Center.

Prerequisites

Setup

  • Open the UwpAddOn.vcxproj in Visual Studio
  • Associate the project with your store account
    • Select the project in the Solution Explorer
    • Select menu Project -> Publish -> Associate app with the store ...
      • Make sure to log in under the account where the package will be uploaded.
      • Addons will not be in the list, so pick any app you want.
  • Manually update the store association for your AddOn.

Running the sample

  • Open the UwpAddOn.vcxproj in Visual Studio
  • Complete the Setup including manual configuration of the store association
  • Create packages for upload to Partner Center
    • Select the project in the Solution Explorer
    • Select menu Project -> Publish -> Create app packages ...
    • Choose "Microsoft Store as {AppName} by {AppPublisher}". Do not choose side-loading
    • When finished, visit the output location for the packages.

Manually Update Store Association

Visual Studio does not provide a way to associate your sample app to an AddOn, so you can associate it with any app under the account. By associating the project with an app, you are still getting the benefits of having all the publishing information correctly populated for you by Visual Studio. This includes any certificates that might need created or installed to sign your package.

Once the initial association is done, you'll have to perform the following manual steps to correctly configure the AddOn.

  • Open Package.StoreAssociation.xml
  • Update the ProductReservedInfo section to include the Identity and Reserved Name of your AddOn.
<ProductReservedInfo>
    <MainPackageIdentityName>Put.AddOn.Identity.Here</MainPackageIdentityName>
    <ReservedNames>
        <ReservedName>Put.AddOn.Reserved.Name.Here</ReservedName>
    </ReservedNames>
</ProductReservedInfo>
  • Open Package.appxmanifest with the XML editor (use Open With)
  • Update the AddOn Identity Name
  <Identity Name="Put.AddOn.Identity.Here" . . . />
  • Update the Addon DiplayName or Reserved Name.
  <Properties>
    <DisplayName>Put.AddOn.Reserved.Name.Here</DisplayName>
    . . .
  </Properties>
  • Update the MainPackageDependency. This will be the Identity of the parent app.
  <Dependencies>
    . . .
    <uap3:MainPackageDependency Name="Put.Parent.App.Identity.Here" />
  </Dependencies>

License

MIT

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.