Nexus
Obtain the framework and prepare your environment
Prepare the framework, starter template, and runtime components. Keep using your preferred editor and frontend tools. Framework source, official examples, and starter templates are available in the project's GitHub repository.
Prepare materials for your workflow
Website · Project source · Report an issue.
Use Download & Install inside the add-on. It selects a matching runtime from the company's file service without manual package selection.
Framework, official examples, and runtime downloads are free.
For a new add-on, prepare the official framework, starter template, and runtime components. To migrate an existing web interface, also bring your pages, build output, and assets. Use the template and copy tool directly from the source repository.
| Material | Purpose | Check on receipt |
|---|---|---|
| Official framework source | Embedded in your add-on to provide integration. | Clear source, complete files, and matching template/manifest from the same delivery. |
| Starter template and copy tool | Structure for registration, windows, communication, closing, and packaging. | Complete template-owned files and copy tool, not only a website snippet. |
| Runtime components | Run web windows locally. | Must match platform and framework. Download later online or prepare a ZIP ahead of time offline. |
The repository also contains maintenance and learning materials. Having it does not mean embedding the whole repository in an add-on.
What to find in the full source
nexus_web/: source for copying the framework.-
skill/nexus-ui-web/assets/plugin-template/: starter template for new add-ons. -
skill/nexus-ui-web/scripts/copy_framework.py: manifest-driven framework copy tool. -
examples/: official examples to read and try, not public dependencies for your add-on.
A standalone framework directory may lack templates, tools, and examples. Obtain complete matching materials rather than inventing missing framework files. Website files alone cannot create a complete add-on.
Try official examples from complete source
Official examples need no packaging. In the complete source, open
examples/panel/help-zh.html and follow the guide for Blender's local extension repository and directory layout. Name the root
nexus_web_ui, place it in the local repository, refresh local add-ons in preferences, and enable Nexus UI Web. Do not treat a source archive as an installable extension ZIP.
Expand add-on information for purpose, examples, local help, and licenses. In the 3D View sidebar, choose Web. If matching runtime components are missing, use the download card or a local ZIP; example buttons may not appear yet. Reuse compatible installed components. Once ready, choose Example Windows → Floating UI. Texture Studio is in the Shader Editor context menu. The assistant additionally needs uv, an isolated environment, and your own compatible service URL, key, and model. No provider is preset. Fetch or enter models in settings. A model list does not verify chat or scene actions; scene tools also require model tool-calling support and separately configured Blender MCP. You pay third-party service charges. Follow the supplied guide after trying basic examples.
Local help needs neither networking nor installed runtime components. Minimum Blender declarations do not prove every later version/platform was tested. Check public access and platform results against the final release candidate.
Prepare your own add-on directory
- First follow Requirements Confirm Blender, platform, and development tools.
- Choose a new directory outside the framework repository. Keep original source as a reference rather than turning the repository into your add-on.
- Copy the full template, rename IDs/classes/display text consistently, and preserve licensing.
- Prepare its manifest, then use the matching tool to copy permitted framework files.
- Keep page, Python, and manifest paths aligned. Check delivery inclusion after adding or changing files.
Commands, directory trees, and renaming tables are centralized in Prepare your add-on directory. Existing projects use integration/update flows, not a new-project overwrite.
What to copy and what to leave
| Content | Handling |
|---|---|
| Template-owned files | Use as a starting point, customize, and retain attribution. |
| Official framework files | Copy by manifest using the tool, excluding caches and temporary files. |
| Local pages and required assets | Ship with the add-on. For built frontends, ship output without requiring users to run development projects. |
| Runtime components | Install separately or deliver a separate ZIP; do not nest in the add-on. |
| Website, QA, maintenance tools, official examples | Not runtime dependencies of new add-ons. Read as reference when needed. |
| Root CEF, caches, and local configuration | Do not copy/package. These differ from the framework's internal cef source directory. |
If the copy tool refuses, inspect why
A framework directory already exists
The tool refuses overwrite to separate creation from updates. Check the target and whether integration already exists. Follow the add-on's update flow rather than deleting the directory and retrying blindly.
Manifest/source identity mismatch
Use framework, template, and tool from the same complete delivery. Do not edit validation or trim manifests to bypass errors. Obtain consistent sources; missing files or mixed snapshots may be unusable.
Does copying mean installation is finished?
No. It only prepares framework files. Enable the add-on, install matching runtime components, open a window, and perform a real operation. Follow the first-build tutorial.