Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 16 additions & 7 deletions interface/settings/3d.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -55,17 +55,26 @@ The light settings in this section are used to set the default lighting settings
Change the background color, which can also be adjusted in the canvas.
![Initial Background Color vs Modified](/images/interface/setting/3d/background_color.jpg)

### Initial Preview Visibility
- **Function**: Controls whether the preview screen is displayed by default when creating new 3D components. This default setting can still be toggled individually for each component after creation
- **Default Value**: true (enabled)

![Preview vs hide preview](/images/interface/setting/3d/hide_preview.jpg)


### Initial Grid Visibility
- **Function**: Controls whether the grid is displayed by default when creating new 3D components. This default setting can still be toggled individually for each component after creation
- **Default Value**: true (enabled)

Hide or show the grid on initialization

![Show grid vs hide grid](/images/interface/setting/3d/hide_grid.jpg)


## 3D Viewer

### Enable 3D Viewer (Beta)
- **Setting ID**: `Comfy.Load3D.3DViewerEnable`
- **Type**: boolean
- **Default Value**: false (disabled)
- **Function**: Controls whether the 3D Viewer (Beta) is enabled. When enabled, a button will appear on 3D component nodes that can be clicked to open a full-size 3D viewer

### PLY Engine
- **Setting ID**: `Comfy.Load3D.PLYEngine`
- **Type**: combo
- **Options**: `threejs`, `fastply`, `sparkjs`
- **Default Value**: `threejs`
- **Function**: Selects the engine used to load PLY files. `threejs` uses the native Three.js PLYLoader (best for mesh PLY files), `fastply` uses a loader optimized for ASCII point cloud PLY files, and `sparkjs` uses Spark.js to load 3D Gaussian Splatting PLY files
47 changes: 41 additions & 6 deletions interface/settings/about.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,20 @@ The About page is an information display panel in the ComfyUI settings system, u

The About page displays the following core version information:

- **ComfyUI Version**: Shows the backend ComfyUI version number, linked to the official GitHub repository
- **ComfyUI Version**: Shows the backend ComfyUI version. The format depends on the distribution:
- **OSS (Open Source)**: Displays `ComfyUI <commit hash>`, linked to the main [GitHub repository](https://github.com/Comfy-Org/ComfyUI)
- **Desktop**: Displays `ComfyUI v<version>`, linked to the same GitHub repository
- **Cloud**: Displays `ComfyUI <commit hash>`, linked to [comfy.org](https://www.comfy.org) with a cloud icon
- **ComfyUI_frontend Version**: Shows the frontend interface version number, linked to the frontend GitHub repository
- **Templates Version**: If `systemStats.system.installed_templates_version` is available, a Templates badge is displayed:
- Label: `Templates v<version>`
- Link: [https://pypi.org/project/comfyui-workflow-templates/](https://pypi.org/project/comfyui-workflow-templates/)
- Icon: `pi pi-book`
- If the installed version differs from the required version, the badge appears with a **danger** severity level (red)
Comment thread
coderabbitai[bot] marked this conversation as resolved.
- **Discord Community**: Provides a link to the ComfyOrg Discord server
- **Official Website**: Links to the ComfyOrg official website
- **ComfyOrg**: Links to the ComfyOrg official website

The badges are displayed in the following order: ComfyUI → Frontend → Templates (if installed) → Discord → ComfyOrg.

<Tip>
Since the version information here mainly corresponds to stable version information, if you are using the nightly version, the corresponding commit hash will not be displayed here. If you are using the nightly version, you can use the `git log` command in the corresponding ComfyUI main directory to view the corresponding commit hash and other information.
Expand All @@ -33,10 +43,35 @@ If custom nodes are installed, the About page will also display additional badge

### System Info

The bottom of the page displays detailed system statistics, including:
- Hardware configuration information
- Software environment information
- System performance data
The bottom of the page displays detailed system statistics, which vary depending on the distribution:

**OSS / General Version:**
- **OS**: Operating system identifier
- **Python Version**: Installed Python version
- **Embedded Python**: Embedded Python details (if applicable)
- **Pytorch Version**: PyTorch framework version
- **Arguments (argv)**: Command-line arguments used to launch ComfyUI
- **RAM Total**: Total available system RAM
- **RAM Free**: Currently free system RAM
- **Templates Version**: Shown with danger styling if the installed version is outdated

**Cloud Version:**
- **Cloud Version**: Cloud platform version
- **ComfyUI Version**: Backend ComfyUI version
- **Frontend Version**: Frontend interface version
- **Templates Version**: Workflow templates version

**Devices** (displayed when compatible hardware is detected):
- Device name and type (e.g. GPU model)
- **VRAM Total / VRAM Free**: Graphics memory statistics
- **Torch VRAM Total / Torch VRAM Free**: PyTorch-managed VRAM statistics
- Multiple devices are presented in a **TabView**, one tab per device

A **Copy System Info** button is provided at the bottom, which copies all system information in a formatted text block to the clipboard for easy sharing when reporting issues.

### Version Update Notifications

The `ShowVersionUpdates` setting (found under Comfy → Notification Preferences) controls whether version update notifications are shown on the About page and elsewhere in the interface.

## Extension Developer Guide

Expand Down
Loading
Loading