Msix #

A command-line tool that create Msix installer from your flutter windows-build files.

📋 Install #

In your pubspec.yaml, add msix as a new dependency:

dev_dependencies:
  flutter_test:
    sdk: flutter
  msix: ^2.5.2

📦 Create Msix #

Run the commands:

PS c:\src\flutter_project\> flutter build windows
PS c:\src\flutter_project\> flutter pub run msix:create

The flutter build windows is required to build the executable that flutter pub run msix:create bundles up in the MSIX install file.

⚙ Configuration (Optional) #

This package have default configuration values, but you can configure it to suit your needs by adding msix_config: at the end of your pubspec.yaml file:

msix_config:
  display_name: MyAppName
  publisher_display_name: MyName
  identity_name: MyCompany.MySuite.MyApp
  msix_version: 1.0.0.0
  logo_path: C:\<PathToIcon>\<Logo.png>
  capabilities: 'internetClient,location,microphone,webcam'

See full list of available configurations.

✒️ Signing Options #

.msix installer must be sign with certificate (.pfx)

• this package will automatically sign your app with build in test certificate.
• if you publish your app to the Windows Store, the app will automatically sign by the store.
• if you need to use your own certificate, use the configuration fields:certificate_path, certificate_password

Note: by default, this package will install the certificate on your machine, you can disable it by using the --dontInstallCert flag or the configuration: dont_install_cert: true

Windows Store #

To generate msix file for publish to the Windows Store, use the --store flag or add store: true in msix configuration section in your pubspec.yaml.

Note:

For Windows Store publication the configuration values: publisher_display_name, identity_name, msix_version, publisher must be valid, you can find those values in your windows store dashboard (Product > Product identity) see image.

For more information about publish to the Windows Store see: How to publish your MSIX package to the Microsoft Store

📁 .dll Files And Assets (FFI Library) #

To include your .dll and other third party assets in your msix installer, you can use the configuration field: assets_directory_path:

assets_directory_path:  'C:\Users\me\flutter_project_name\myAssets'

1. create new folder in your root project folder (where pubspec.yaml is located)
2. put there all your assets (.dll etc.)
3. in your application code, use the FFI package like so:

var helloLib = ffi.DynamicLibrary.open('myAssets/hello.dll');
var helloLib2 = ffi.DynamicLibrary.open('myAssets/subFolder/hello2.dll');

Note: don't use absolute path:

var absolutePath = path.join(Directory.current.path, 'myAssets/hello.dll');
var helloLib = ffi.DynamicLibrary.open(absolutePath);

📋 Available Configuration Fields: #

Command-Line Arguments

You can use also the CLI arguments to set the configuration value, for example:

flutter pub run msix:create --v 1.0.3.3 --c C:/Users/me/Desktop/test_certificate.pfx --p 1234 --pu "CN=Msix Testing, O=Msix Testing Corporation, C=US"

Available Arguments Options:

• package version: --v (must be in the format: 1.0.0.0)
• certificate path: --c
• certificate password: --p
• debug signing problems: --d
• display name: --dn
• publisher display name: --pdn
• identity name: --in
• logo path: --lp
• start_menu icon path: --smip
• tile icon path: --tip
• assets directory path: --adp
• vs generated images folder path: --vsi
• icons background color: --ibc
• signtool options: --so
• protocol activation: --pa
• file extension: --fe
• architecture: --a
• capabilities: --cap
• languages: --l

Available Arguments Flags:

• store: --store
• debug: --debug
• don't install certificate: --dontInstallCert

package tags: msi windows win10 win11 windows10 windows11 windows store windows installer windows packaging appx AppxManifest SignTool MakeAppx