Project Centennial - First hands on Converting desktop apps to Universal Windows Platform (UWP)
There was a huge expectation about the Project Centennial also famously known as Project C. I promise it will not disappoint any of you. I was very eager to have my hands on it and experiment it more and so here I am explaining the conversion steps in detail with a test desktop app.
Prior to conversion one should know the advantages of converting desktop apps to UWP. To know more check the below link.
https://msdn.microsoft.com/windows/uwp/porting/desktop-to-uwp-root
Microsoft has released its pre-release version of Desktop App Converter tool which can be used to convert all the existing desktop apps written for .NET 4.6.1 or Win32 to the Universal Windows Platform (UWP).
Desktop App Converter tool converts a desktop Windows installer such as MSI or EXE to an AppX package that can be deployed to a Windows 10 desktop.
Requirements:
1. Windows 10 Build 10.0.14316.0 or higher(Should be installed physically. Converter will fail in a VM image)
2. Desktop App Converter ( Download - Here )
3. Windows Software Development Kit (SDK) for Windows 10 ( Download Here )
The Desktop App Converter will download two files. BaseImage-14316.wim and
DesktopAppConverter.zip.Extract the DesktopAppConverter.zip files to a desired location.
You can see that there are two files (DesktopAppConverter.cmd and DesktopAppConverter.ps1) DesktopAppConverter.cmd is a cmd wrapper for DesktopAppConverter.ps1.To know more type DesktopAppConverter.cmd -? You can use either CMD or Powershell file for converting purposes.
Now lets convert a test desktop app. Here I am going to use Notepad++ to convert into UWP.
Open Powershell as admin and set the execution policy to unrestricted or bypass.
Enter the below command in the Powershell.The setup command will make the Converter to expand the given base image(BaseImage-14316.wim). To know more about these parameters have a look at the below article.
https://msdn.microsoft.com/windows/uwp/porting/desktop-to-uwp-run-desktop-app-converter
Also note that if you give the absolute path for the DesktopAppConverter.ps1 it will fail. You would need to give the relative path to make it work properly.
Make sure you do not keep any other application in the folder. keep only the application that needs to be converted in the Installer location. In this case only notepad++ installer exe should be kept.
This command will run the notepad++ Installer silently in an isolated environment using a clean base image which we downloaded along with the converter(We have expanded the WIM image earlier). It will capture all the changes like registry and file system I/O made by the notepad++ installer and packages it as part of the output.
You can see the verbose log in the screen as we have used -verbose parameter. Also a log file will be generated in the C:\ drive as we have explicitly mentioned in the above command using -LogFile parameter.
So what happens exactly when running the above script. will see more (Refer the above screenshots while reading the below steps for easy understanding).
Assets folder contains the icons for the package. By default it shows X symbol (I guess this will be rectified in the original release). You would need to change these to original icons. Just extract the icons and replace them here with the same name, so that there will be no changes required to modify the AppXmanifest file further.
If we want to create .AppX Package then we need to follow the below steps.
Use MakeAppX.exe to convert to Appx format (It will be available as a part of Windows SDK)
This will build the loose files to a single AppX package .
In-order to deploy and test the .appx package using the Add-AppxPackage cmdlet, it requires that the application package (.appx) must be signed. For this we can use SignTool.exe, which comes with the Microsoft Windows 10 SDK.
Once signed (you can use a dummy certificate for this step), you can install it successfully.
Testing :Open elevated powershell and run the below command.
This will install the package successfully.
NOTE:
At present the Desktop App Converter supports the conversion process only on a 64-bit OS. You can deploy the converted .appx packages to a 64-bit OS only. Desktop App Converter requires the desktop installer to run under unattended mode.
MVP Tim Mangan has mentioned in his blog that there is a bug in the converter.If you give it a MSI based installer, it ignores the command line parameters that you provide and injects it’s own.To know more check his official blog page.(Interesting read :) )
http://www.tmurgent.com/TmBlog/?p=2448
Also check the review from MVP Rory Monaghan about Project C in his blog below.
http://rorymon.com/blog/?p=3490
Also check the blog post from Simon Binder below.
https://bindertech.wordpress.com/2016/04/08/get-started-with-project-centennial/
You can also watch the below video from Microsoft Channel9 to know more about the use of Desktop App Converter tool to convert desktop apps to UWP with demo.
To know more check the below official link from Microsoft.
https://developer.microsoft.com/en-us/windows/bridges/desktop
Prior to conversion one should know the advantages of converting desktop apps to UWP. To know more check the below link.
https://msdn.microsoft.com/windows/uwp/porting/desktop-to-uwp-root
Microsoft has released its pre-release version of Desktop App Converter tool which can be used to convert all the existing desktop apps written for .NET 4.6.1 or Win32 to the Universal Windows Platform (UWP).
Desktop App Converter tool converts a desktop Windows installer such as MSI or EXE to an AppX package that can be deployed to a Windows 10 desktop.
Requirements:
1. Windows 10 Build 10.0.14316.0 or higher(Should be installed physically. Converter will fail in a VM image)
2. Desktop App Converter ( Download - Here )
3. Windows Software Development Kit (SDK) for Windows 10 ( Download Here )
The Desktop App Converter will download two files. BaseImage-14316.wim and
DesktopAppConverter.zip.Extract the DesktopAppConverter.zip files to a desired location.
You can see that there are two files (DesktopAppConverter.cmd and DesktopAppConverter.ps1) DesktopAppConverter.cmd is a cmd wrapper for DesktopAppConverter.ps1.To know more type DesktopAppConverter.cmd -? You can use either CMD or Powershell file for converting purposes.
Now lets convert a test desktop app. Here I am going to use Notepad++ to convert into UWP.
Open Powershell as admin and set the execution policy to unrestricted or bypass.
Enter the below command in the Powershell.The setup command will make the Converter to expand the given base image(BaseImage-14316.wim). To know more about these parameters have a look at the below article.
https://msdn.microsoft.com/windows/uwp/porting/desktop-to-uwp-run-desktop-app-converter
"path to DesktopAppConverter.ps1" -Setup -BaseImage "path to BaseImage-14316.wim"
If it asks for reboot,Restart the machine and run the command again.
Also note that if you give the absolute path for the DesktopAppConverter.ps1 it will fail. You would need to give the relative path to make it work properly.
It will take some time to expand the base image, so you would need to wait patiently.It expands the base image to the below path.
Enter the below command to perform conversion in an elevated Powershell.
"path to DesktopAppConverter.ps1" –Installer "C:\test\npp.6.8.2.Installer.exe" -InstallerArguments "/S" -Destination "C:\Output\notepadplusplus"
-PackageName "Notepadplus" -Publisher "CN=Notepadplusplus" -Version 6.8.2.0 -ExpandedBaseImage C:\ProgramData\Microsoft\Windows\Images\BaseImage-14316 -Verbose -LogFile "c:\notepad.log"
Make sure you do not keep any other application in the folder. keep only the application that needs to be converted in the Installer location. In this case only notepad++ installer exe should be kept.
This command will run the notepad++ Installer silently in an isolated environment using a clean base image which we downloaded along with the converter(We have expanded the WIM image earlier). It will capture all the changes like registry and file system I/O made by the notepad++ installer and packages it as part of the output.
You can see the verbose log in the screen as we have used -verbose parameter. Also a log file will be generated in the C:\ drive as we have explicitly mentioned in the above command using -LogFile parameter.
So what happens exactly when running the above script. will see more (Refer the above screenshots while reading the below steps for easy understanding).
- The script does a Pre-Requisite check like checking Minimum Windows Version,PowerShell Version etc..
- It Validates the given parameters like Installer presence, Output Folder presence (If it is not there it will create the folder)
- It will Setup Conversion Environment for Capturing.
- It Creates AppX Manifest file. This acts as the Core DNA of the Application. It is the Metadata for the package that contains all the required information including extension points, FTA's, shortcuts and the identity names associated with the package.You can customize this file for any changes to be made after capturing the package.
- It Generates Virtual File System (VFS). All the files that are captured will be placed here.Additionally there will be Assets Folder which contains Icons [This is created by the Converter].If you are working on App-V then you can relate these things as both are quite same.
- It Generates Virtual Registry System (Registry.dat). It Contains all the registry changes that were made by the Installer.
Assets folder contains the icons for the package. By default it shows X symbol (I guess this will be rectified in the original release). You would need to change these to original icons. Just extract the icons and replace them here with the same name, so that there will be no changes required to modify the AppXmanifest file further.
If we want to create .AppX Package then we need to follow the below steps.
Use MakeAppX.exe to convert to Appx format (It will be available as a part of Windows SDK)
MakeAppx.exe Pack -d "Path of Directory Containing the VFS, Registry.Dat & AppXManifest.xml"-p "Path to output folder"
This will build the loose files to a single AppX package .
In-order to deploy and test the .appx package using the Add-AppxPackage cmdlet, it requires that the application package (.appx) must be signed. For this we can use SignTool.exe, which comes with the Microsoft Windows 10 SDK.
Once signed (you can use a dummy certificate for this step), you can install it successfully.
Testing :Open elevated powershell and run the below command.
Add-AppxPackage "Path to .AppX File"
This will install the package successfully.
NOTE:
At present the Desktop App Converter supports the conversion process only on a 64-bit OS. You can deploy the converted .appx packages to a 64-bit OS only. Desktop App Converter requires the desktop installer to run under unattended mode.
MVP Tim Mangan has mentioned in his blog that there is a bug in the converter.If you give it a MSI based installer, it ignores the command line parameters that you provide and injects it’s own.To know more check his official blog page.(Interesting read :) )
http://www.tmurgent.com/TmBlog/?p=2448
Also check the review from MVP Rory Monaghan about Project C in his blog below.
http://rorymon.com/blog/?p=3490
Also check the blog post from Simon Binder below.
https://bindertech.wordpress.com/2016/04/08/get-started-with-project-centennial/
You can also watch the below video from Microsoft Channel9 to know more about the use of Desktop App Converter tool to convert desktop apps to UWP with demo.
To know more check the below official link from Microsoft.
https://developer.microsoft.com/en-us/windows/bridges/desktop
Comments
Post a Comment