Package Support Framework
The Package Support Framework is an open source kit that helps you apply fixes to your existing win32 application when you don't have access to the source code, so that it can run in an MSIX container. The Package Support Framework helps your application follow the best practices of the modern runtime environment.
Here are some common examples where you can find the Package Support Framework useful:
- Your app can't find some DLLs when launched. You may need to set your current working directory. You can learn about the required current working directory in the original shortcut before you converted to MSIX.
- The app writes into the install folder. You will typically see it by "Access Denied" errors in Process Monitor.
- Your app needs to pass parameters to the executable on launch. You can learn more about how to identify this issue here and learn more about the available configurations here.
To create the Package Support Framework, we leveraged the Detours technology which is an open source framework developed by Microsoft Research (MSR) and helps with API redirection and hooking.
This framework is open source, lightweight, and you can use it to address application issues quickly. It also gives you the opportunity to consult with the community around the globe, and to build on top of the investments of others.
For a step-by-step guide, see Apply runtime fixes to an MSIX package by using the Package Support Framework.
A quick look inside of the Package Support Framework
The Package Support Framework contains an executable, a runtime manager DLL, and a set of runtime fixes.
Here's how it works. You'll create a configuration file that specifies the fixes that you want to apply to your application. Then, you'll modify your package to point to the Package Support Framework (PSF) launcher executable file.
When users start your application, the Package Support Framework launcher is the first executable that runs. It reads your configuration file and injects the runtime fixes and the runtime manager DLL into the application process. The runtime manager applies the fix when it's needed by the application to run inside of an MSIX container.
Get started using the Package Support Framework
After you create a package for your application, install and run it, and observe its behavior. You might receive error messages that can help you identify a compatibility issue. You can also use Process Monitor to identify issues.
After you find an issue, you can check our GitHub page for a fix. If you find one, you can apply it to your package. Our step-by-step guide shows you how to do this. It will also show you how to use the Visual Studio debugger to step through your application and verify that the fix is working and that it has resolved the compatibility issue.
If you can't find a runtime fix that addresses your issue, you can create one. To do that, you'll identify which function calls fail when your application runs in an MSIX container. Then, you can create replacement functions that you'd like the runtime manager to call instead. This gives you an opportunity to replace the implementation of a function with behavior that conforms to the rules of the modern runtime environment.
You can also use the Package Support Framework to run scripts to customize an application for the user environment dynamically. For more information, see this article.
The Package Support Framework does not support registry overrides. It is designed to resolve run time issues.
Data and telemetry
The Package Support Framework includes telemetry that collects usage data and sends it to Microsoft to help improve our products and services. Read Microsoft's privacy statement to learn more. However, data will be collected only when both of the following conditions are met:
- The Package Support Framework binaries are used from the NuGet package on a Windows 10 computer.
- The user has enabled collection of data on the computer.
The NuGet package contains signed binaries and will collect usage data from the computer. Telemetry is not collected when the binaries are built locally by cloning the repo or downloading the binaries directly.