Documentation
    Preparing search index...

    Interface MakerAppXConfig

    Configuration for the legacy AppX maker.

    Use @electron-forge/maker-msix and its MakerMSIXConfig instead. These options are mapped onto electron-windows-msix; options marked as deprecated below have no MSIX equivalent and are ignored.

    interface MakerAppXConfig {
        assets?: string;
        certPass?: string;
        containerVirtualization?: boolean;
        createConfigParams?: string[];
        createPriParams?: string[];
        deploy?: boolean;
        desktopConverter?: string;
        devCert?: string;
        expandedBaseImage?: string;
        finalSay?: () => Promise<void>;
        flatten?: boolean;
        makeappxParams?: string[];
        makePri?: boolean;
        makeVersionWinStoreCompatible?: boolean;
        manifest?: string;
        packageBackgroundColor?: string;
        packageDescription?: string;
        packageDisplayName?: string;
        packageExecutable?: string;
        packageName?: string;
        packageVersion?: string;
        publisher?: string;
        signtoolParams?: string[];
        windowsKit?: string;
    }
    Index

    Properties

    assets? certPass? containerVirtualization? createConfigParams? createPriParams? deploy? desktopConverter? devCert? expandedBaseImage? finalSay? flatten? makeappxParams? makePri? makeVersionWinStoreCompatible? manifest? packageBackgroundColor? packageDescription? packageDisplayName? packageExecutable? packageName? packageVersion? publisher? signtoolParams? windowsKit?

    Properties

    assets?: string

    Path to a folder of visual assets (icons and tile images) for the package manifest. Unless a custom MakerAppXConfig.manifest is set, the folder must contain the files the generated manifest refers to: icon.png, Square44x44Logo.png and Square150x150Logo.png. These differ from the SampleAppx.*.png names used by electron-windows-store.

    certPass?: string

    Password for MakerAppXConfig.devCert. Required by @electron/windows-sign unless MakerAppXConfig.signtoolParams is set, so a password-less certificate needs signtoolParams. Ignored when devCert is unset.

    containerVirtualization?: boolean

    Ignored. The Desktop App Converter code path was removed together with electron-windows-store.

    createConfigParams?: string[]

    Ignored. electron-windows-msix does not accept extra makepri.exe parameters.

    createPriParams?: string[]

    Ignored. electron-windows-msix does not accept extra makepri.exe parameters.

    deploy?: boolean

    Ignored. Install the generated .msix yourself.

    desktopConverter?: string

    Ignored. The Desktop App Converter code path was removed together with electron-windows-store.

    devCert?: string

    Path to a .pfx certificate to sign the package with. When unset, electron-windows-msix signs the package with a self-signed development certificate, which is saved next to the .msix as dev_cert.cer and dev_cert.pfx so it can be trusted on a test device. The .pfx password is WINDOWS_CERTIFICATE_PASSWORD when that environment variable is set, otherwise a random one.

    Signing timestamps against http://timestamp.digicert.com unless the WINDOWS_TIMESTAMP_SERVER environment variable names another server.

    expandedBaseImage?: string

    Ignored. The Desktop App Converter code path was removed together with electron-windows-store.

    finalSay?: () => Promise<void>

    Ignored. There is no pre-packaging hook in electron-windows-msix.

    flatten?: boolean

    Ignored. It was never read by electron-windows-store either.

    makeappxParams?: string[]

    Ignored. electron-windows-msix does not accept extra makeappx.exe parameters.

    makePri?: boolean

    Whether to generate resources.pri with makepri.exe.

    false
    makeVersionWinStoreCompatible?: boolean

    Strip semver prerelease and build metadata from the version instead of failing, so that it fits the X.Y.Z.A format the Windows Store requires.

    manifest?: string

    Path to a custom AppxManifest.xml. When set, the manifest-related options above are ignored.

    packageBackgroundColor?: string

    The background color of the package's visual elements.

    packageDescription?: string

    packageJSON.description, falling back to the app name

    packageDisplayName?: string
    The app name
    packageExecutable?: string

    The executable to launch, relative to the packaged app directory. A leading app\\ segment is accepted for backwards compatibility.

    <appName>.exe

    packageName?: string

    The identity name of the package, also used as the base name of the generated .msix file.

    packageJSON.name with dashes removed

    packageVersion?: string

    The version of the package in the X.Y.Z.A format.

    ${packageJSON.version}.0

    publisher?: string

    The publisher of the package as an X.500 distinguished name, e.g. CN=developmentca. It must match the subject of the signing certificate.

    CN=<author.name from package.json>

    signtoolParams?: string[]

    Extra parameters for signtool.exe, passed through as signWithParams of @electron/windows-sign. Only used when MakerAppXConfig.devCert is set.

    windowsKit?: string

    Path to the Windows Kit bin folder containing makeappx.exe, makepri.exe and signtool.exe. When unset, the maker searches the default Windows Kits install locations (preferring the newest SDK) and otherwise leaves the lookup to electron-windows-msix.

    Settings

    Member Visibility

    On This Page

    Properties