{
"repo": "cmake-msix",
"timestamp": "2026-01-16T23:56:23.411Z",
"entryPoint": "index.js",
"exports": {
"packageJson": {}
},
"api": {},
"readme": {
"content": "# cmake-msix\n\nFunctions to simplify the creation of MSIX packages for distributing Windows applications.\n\n## API\n\n#### `find_make_appx`\n\nLocates the `MakeAppx.exe` tool from the Windows SDK, required for building MSIX packages.\n\n```cmake\nfind_make_appx(<result>)\n```\n\n##### `<result>`\nAn output variable where the path to the `MakeAppx.exe` executable will be stored.\n\n#### `add_app_manifest`\n\nGenerates the core `AppxManifest.xml` file, which defines essential metadata for the MSIX package.\n\n```cmake\nadd_appx_manifest(\n <target>\n [DESTINATION <path>]\n NAME <string>\n VERSION <string>\n PUBLISHER <string>\n [DISPLAY_NAME <string>]\n PUBLISHER_DISPLAY_NAME <string>\n DESCRIPTION <string>\n [UNVIRTUALIZED_PATHS <path...>]\n)\n```\n\n##### `<target>`\nThe name of the CMake target to create.\n\n##### `DESTINATION <path>`\nThe output file path for the `AppxManifest.xml`. Defaults to `\"AppxManifest.xml\"` in the build directory.\n\n##### `NAME <string>`\nThe name of the application.\n\n##### `VERSION <stri",
"sections": [
"intro",
"api",
"license"
],
"hasApi": true,
"hasExamples": true,
"exampleCount": 3,
"examples": [
"##### `<result>`\nAn output variable where the path to the `MakeAppx.exe` executable will be stored.\n\n#### `add_app_manifest`\n\nGenerates the core `AppxManifest.xml` file, which defines essential metadata for the MSIX package.",
"##### `<target>`\nThe name of the CMake target to create.\n\n##### `DESTINATION <path>`\nThe output file path for the `AppxManifest.xml`. Defaults to `\"AppxManifest.xml\"` in the build directory.\n\n##### `NAME <string>`\nThe name of the application.\n\n##### `VERSION <string>`\nThe semantic version of the application.\n\n##### `PUBLISHER <string>`\nThe publisher of the application.\n\n##### `DISPLAY_NAME <string>`\nThe name displayed to users. Defaults to `\"${NAME}\"`.\n\n##### `PUBLISHER_DISPLAY_NAME <string>`\nThe publisher's display name.\n\n##### `DESCRIPTION <string>`\nA description of the application.\n\n##### `UNVIRTUALIZED_PATHS <path...>`\nA list of paths that should remain unvirtualized within the MSIX package.\n\n#### `add_appx_mapping`\n\nCreates a `Mapping.txt` file that specifies the file structure within the MSIX package.",
"##### `<target>`\nThe name of the CMake target to create.\n\n##### `DESTINATION <path>`\nThe output file path for the `Mapping.txt`. Defaults to `\"Mapping.txt\"` in the build directory.\n\n##### `ICON <path>`\nPath to the application icon.\n\n##### `TARGET <target>`\nAn existing CMake target representing the core executable of your application.\n\n##### `EXECUTABLE <path>`\nDirect path to the application executable. Use if not providing `TARGET`.\n\n##### `RESOURCES [FILE|DIR <from> <to>]...`\nA list of additional files or directories to include.\n\n###### `FILE <from> <to>`\nCopies a file from `<from>` to `<to>` within the MSIX package.\n\n###### `DIR <from> <to>`\nCopies an entire directory from `<from>` to `<to>` within the MSIX package.\n\n#### `add_msix_package`\n\nThe central function to generate the final MSIX package."
]
},
"patterns": []
}