Install and check runtime components

Installed separately from the add-on

Runtime components are local programs that run web pages inside Blender. Your add-on includes its pages, Python code, and framework copy. Runtime components are installed in a shared location for the current user, so you do not need to copy them into each add-on or compile CEF yourself.

Users with an add-on can install from Blender as described here. Authors can continue after First-build tutorial and enabling their add-on. First check that Platforms and Blender versions are met.

Source and build instructions for framework 0.2.0: View fixed version · Download complete source · Build instructions. Runtime components use independent version numbers. Refer to the source information included in each runtime package for its corresponding source code.

When maintaining the framework or running source checks, first read First-time development setup; when native compile checks are needed on the current platform, follow Platform compile setup to add the corresponding tools. Ordinary add-on users do not need these development tools.

When the card appears

After successful enablement and binding, missing, damaged, or incompatible components may trigger the built-in card without a successfully opened page. Showing the notice does not begin downloading.

If neither card nor window appears, check enablement, errors, and entry point. If a dismissed card does not return, save, restart Blender, enable, and try again. No visible card does not prove runtime completeness.

Button names below describe the installation controls in Blender. This website only provides instructions.

Method 1: download and install online

1. Enable the add-on on a supported platform, open its web entry, and inspect the card.
2. After allowing the download, click Download & Install. Platform and compatibility matching select the package automatically.
3. Wait for download, validation, extraction, and installation. 100% download does not mean installation and startup completed.
4. If components are in use, close web windows and other Blender instances using Nexus UI Web, then continue as instructed.
5. After the runtime-ready message, return to the add-on entry and perform the actual checks below.

First installation on Mac: the runtime components are locally signed and have not been notarized by Apple. Approve them yourself only if you trust the source and choose to run them. Keep Blender and the original download card open. When macOS says NexusWebUIRuntime was not opened, choose Done. In System Settings → Privacy & Security, select Open Anyway under Security and confirm as requested. Return to the original card and choose Retry. Updates may require approval again; contact your administrator if organizational policy prevents approval.

If Blender disallows networking, the card explains why. Use a local package offline.

Method 2: install a local package

1. Obtain a provider-supplied, platform/architecture/framework-matched runtime ZIP. It is separate from the add-on ZIP.
2. Keep the ZIP intact. Do not repackage or paste extracted files into the add-on.
3. In the card, click Local Package… and select the ZIP.
4. Wait for validation and installation. Offline installation still checks structure and compatibility.
5. Once ready, open the actual add-on window in Blender.

For invalid packages, confirm it is a runtime ZIP for the correct platform and verify integrity with the provider. Renaming or splicing files does not bypass validation.

Pause, resume, and clear cache

Controls depend on job state. Cleanup is refused while an installer owns the download directory; do not delete the shared runtime manually. Validation, extraction, and installation are distinct from downloading. Follow available controls.

Confirm actual usability

• Installation complete: Check beyond progress; no validation, installation, or startup error remains.
• Window visible: Open through the actual add-on entry and see complete content, not merely a browser preview.
• Input works: Try a normal control: typing, clicking, or dragging.
• Application works: Run a read-only scene query and compare displayed values with the actual scene.
• Closing works: Close and reopen, then continue using it.

Found components proves only some static conditions, not these real operations. This website does not perform local Blender verification for you.

Handle common messages

For diagnosis, provide steps, exact messages, Blender version, architecture, framework source, and installation method. Exclude passwords, private keys, and unrelated files.

Updates and offline sources

When Blender permits online access, all usable installations can check compatible server versions regardless of source. A known compatible upgrade shows current/available versions, size, Download & Update, and Later. Identical local/server packages are not repeatedly offered.

Historical packages without versions show Not recorded and offer Download & Install for compatible components. Checks never install automatically; local ZIP installation remains offline. Runtime components have their own three-part version numbers, separate from the framework. Updating runtime does not update embedded framework source or add-on functionality.

The installer manages the active shared version. Do not manually copy/splice executables or merge framework copies across add-ons.

Return to your first tool