Skip to content

Commit 5f38388

Browse files
authored
Add VBSCRIPT requirement documentation for MSI builds (#3382)
1 parent a293fd9 commit 5f38388

File tree

2 files changed

+22
-0
lines changed

2 files changed

+22
-0
lines changed

src/content/docs/distribute/windows-installer.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,10 @@ To build and bundle your app into a Windows installer you can use the Tauri CLI
2929
cargo="cargo tauri build"
3030
/>
3131

32+
:::note[VBSCRIPT requirement for MSI packages]
33+
Building MSI packages (`"targets": "msi"` or `"targets": "all"` in `tauri.conf.json`) requires the VBSCRIPT optional feature to be enabled on Windows. This feature is enabled by default on most Windows installations, but if you encounter errors like `failed to run light.exe`, you may need to enable it manually through **Settings****Apps****Optional features****More Windows features**. See the [Prerequisites guide](/start/prerequisites/#vbscript-for-msi-installers) for detailed instructions.
34+
:::
35+
3236
### Experimental: Build Windows apps on Linux and macOS
3337

3438
Cross compiling Windows apps on Linux and macOS hosts is possible when using [NSIS].

src/content/docs/start/prerequisites.mdx

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -209,6 +209,24 @@ Tauri uses Microsoft Edge WebView2 to render content on Windows.
209209

210210
Install WebView2 by visiting the [WebView2 Runtime download section](https://developer.microsoft.com/en-us/microsoft-edge/webview2/#download-section). Download the "Evergreen Bootstrapper" and install it.
211211

212+
Next: [Check VBSCRIPT](#vbscript-for-msi-installers)
213+
214+
#### VBSCRIPT (for MSI installers)
215+
216+
:::note[MSI package building only]
217+
This is only required if you plan to build MSI installer packages (`"targets": "msi"` or `"targets": "all"` in `tauri.conf.json`).
218+
:::
219+
220+
Building MSI packages on Windows requires the VBSCRIPT optional feature to be enabled. This feature is enabled by default on most Windows installations, but may have been disabled on some systems.
221+
222+
If you encounter errors like `failed to run light.exe` when building MSI packages, you may need to enable the VBSCRIPT feature:
223+
224+
1. Open **Settings****Apps****Optional features****More Windows features**
225+
2. Locate **VBSCRIPT** in the list and ensure it's checked
226+
3. Click **Next** and restart your computer if prompted
227+
228+
**Note:** VBSCRIPT is currently enabled by default on most Windows installations, but is [being deprecated](https://techcommunity.microsoft.com/blog/windows-itpro-blog/vbscript-deprecation-timelines-and-next-steps/4148301) and may be disabled in future Windows versions.
229+
212230
Next: [Install Rust](#rust)
213231

214232
## Rust

0 commit comments

Comments
 (0)