Skip to content

Commit 16f1e2e

Browse files
XuanYu-githubXuanYu-github
committed
Docs: make Chinese default README
1 parent 71d93b7 commit 16f1e2e

File tree

3 files changed

+124
-32
lines changed

3 files changed

+124
-32
lines changed

‎README.en.md‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# ComfyUI PlyPreview
2+
3+
[中文](README.md) | [English](README.en.md)
4+
5+
Gaussian Splat PLY loader + preview nodes for ComfyUI. Forked from GeometryPack and repackaged to avoid upstream overwrites. Includes front-end viewer (gsplat.js) bundled locally.
6+
7+
## Nodes
8+
- Load Gaussian PLY — dropdown from `input/`, `input/3d`, `output/` with auto-resolution, FOV 10–180°, optional opacity filter.
9+
- Load Gaussian PLY (Path) — manual path entry with the same camera/auto-res options.
10+
- Process Gaussian PLY — accept upstream `ply_path` (e.g., SHARP Predict) with camera override/opacity filter.
11+
- Preview Gaussian — gsplat.js WebGL viewer with scale slider, reset, screenshot, info panel.
12+
13+
## Features
14+
- Auto resolution from FOV + target scale (rounded to 16px, calibration factor 0.8).
15+
- Opacity filtering (sigmoid) with threshold.
16+
- Camera intrinsics/extrinsics outputs for consistent preview.
17+
- Wide FOV (10–180°) including fisheye cases.
18+
- Fully self-contained: viewer HTML/JS bundled under `web/`.
19+
20+
## Install (Git clone)
21+
```bash
22+
cd ComfyUI/custom_nodes
23+
git clone https://github.com/XuanYu-github/comfyui-PlyPreview.git
24+
```
25+
Restart ComfyUI.
26+
27+
## Install (ComfyUI Manager)
28+
Search for “comfyui-PlyPreview” in Manager and install. (This repo ships `comfyui_extension.json` so Manager can detect it.)
29+
30+
## Usage
31+
1) Use one of the Load nodes or Process node to produce `ply_path`, `extrinsics`, `intrinsics`.
32+
2) Connect to Preview Gaussian. After execution the viewer iframe shows controls (Scale, Reset View, Screenshot) and info panel.
33+
3) If opacity filtering is enabled, a filtered PLY is written alongside the source (suffix `_opacity{threshold}.ply`).
34+
35+
## Requirements
36+
- ComfyUI recent build with DOM widgets enabled (standard).
37+
- Python deps: `plyfile`, `numpy` (install via your ComfyUI environment). Most ComfyUI setups already have numpy; install plyfile if missing: `pip install plyfile`.
38+
39+
## Notes
40+
- WEB_DIRECTORY is set to `web` so ComfyUI loads the bundled frontend automatically.
41+
- Namespaces are prefixed `PlyPreview*` to avoid collision with GeometryPack.
42+
- Original GeometryPack license is GPL-3.0; this fork keeps the same license.
43+
44+
## License
45+
GPL-3.0-or-later. See [LICENSE](LICENSE).

‎README.md‎

Lines changed: 34 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,45 @@
11
# ComfyUI PlyPreview
22

3-
Gaussian Splat PLY loader + preview nodes for ComfyUI. Forked from GeometryPack and repackaged to avoid upstream overwrites. Includes front-end viewer (gsplat.js) bundled locally.
4-
5-
## Nodes
6-
- Load Gaussian PLY — dropdown from `input/`, `input/3d`, `output/` with auto-resolution, FOV 10–180°, optional opacity filter.
7-
- Load Gaussian PLY (Path) — manual path entry with the same camera/auto-res options.
8-
- Process Gaussian PLY — accept upstream `ply_path` (e.g., SHARP Predict) with camera override/opacity filter.
9-
- Preview Gaussian — gsplat.js WebGL viewer with scale slider, reset, screenshot, info panel.
10-
11-
## Features
12-
- Auto resolution from FOV + target scale (rounded to 16px, calibration factor 0.8).
13-
- Opacity filtering (sigmoid) with threshold.
14-
- Camera intrinsics/extrinsics outputs for consistent preview.
15-
- Wide FOV (10–180°) including fisheye cases.
16-
- Fully self-contained: viewer HTML/JS bundled under `web/`.
17-
18-
## Install (Git clone)
3+
[中文](README.md) | [English](README.en.md)
4+
5+
Gaussian Splat PLY 加载与预览节点，独立于 GeometryPack，内置 gsplat.js 前端查看器。
6+
7+
## 节点
8+
- Load Gaussian PLY：从 `input/`、`input/3d`、`output/` 下拉选择，支持自动分辨率、FOV 10–180°、可选透明度过滤。
9+
- Load Gaussian PLY (Path)：手动输入路径，具备同样的相机/自动分辨率选项。
10+
- Process Gaussian PLY：接收上游 `ply_path`（如 SHARP Predict），可覆盖相机或启用透明度过滤。
11+
- Preview Gaussian：gsplat.js WebGL 预览，提供缩放、重置、截图和信息面板。
12+
13+
## 特性
14+
- 自动分辨率：基于 FOV + target_scale，16 像素对齐，校准系数 0.8。
15+
- 透明度过滤：sigmoid 后按阈值过滤，减少背景噪点。
16+
- 输出相机内外参，预览一致性更好。
17+
- 宽 FOV（10–180°）含鱼眼场景。
18+
- 前端资源全部内置于 `web/`，无需外部依赖。
19+
20+
## 安装（Git clone）
1921
```bash
2022
cd ComfyUI/custom_nodes
2123
git clone https://github.com/XuanYu-github/comfyui-PlyPreview.git
2224
```
23-
Restart ComfyUI.
25+
重启 ComfyUI。
2426

25-
## Install (ComfyUI Manager)
26-
Search for “comfyui-PlyPreview” in Manager and install. (This repo ships `comfyui_extension.json` so Manager can detect it.)
27+
## 安装（ComfyUI Manager）
28+
在 Manager 中搜索 “comfyui-PlyPreview” 安装（内置 `comfyui_extension.json` 可被识别）。
2729

28-
## Usage
29-
1) Use one of the Load nodes or Process node to produce `ply_path`, `extrinsics`, `intrinsics`.
30-
2) Connect to Preview Gaussian. After execution the viewer iframe shows controls (Scale, Reset View, Screenshot) and info panel.
31-
3) If opacity filtering is enabled, a filtered PLY is written alongside the source (suffix `_opacity{threshold}.ply`).
30+
## 使用方法
31+
1) 选择 Load 或 Process 节点，生成 `ply_path`、`extrinsics`、`intrinsics`。
32+
2) 连接 Preview Gaussian，执行后 iframe 显示控制条（Scale、Reset View、Screenshot）和信息面板。
33+
3) 若启用透明度过滤，会在源旁生成 `_opacity{threshold}.ply`。
3234

33-
## Requirements
34-
- ComfyUI recent build with DOM widgets enabled (standard).
35-
- Python deps: `plyfile`, `numpy` (install via your ComfyUI environment). Most ComfyUI setups already have numpy; install plyfile if missing: `pip install plyfile`.
35+
## 依赖
36+
- ComfyUI（默认已启用 DOM widgets）。
37+
- Python：`plyfile`、`numpy`（缺失时 `pip install plyfile numpy`）。
3638

37-
## Notes
38-
- WEB_DIRECTORY is set to `web` so ComfyUI loads the bundled frontend automatically.
39-
- Namespaces are prefixed `PlyPreview*` to avoid collision with GeometryPack.
40-
- Original GeometryPack license is GPL-3.0; this fork keeps the same license.
39+
## 备注
40+
- `WEB_DIRECTORY = "web"`，ComfyUI 会自动加载前端。
41+
- 节点前缀 `PlyPreview*`，避免与 GeometryPack 冲突。
42+
- 继承原 GeometryPack 的 GPL-3.0 许可。
4143

42-
## License
43-
GPL-3.0-or-later. See [LICENSE](LICENSE).
44+
## 许可
45+
GPL-3.0-or-later。详见 [LICENSE](LICENSE)。

‎README.zh-CN.md‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# ComfyUI PlyPreview
2+
3+
Gaussian Splat PLY 加载与预览节点，独立于 GeometryPack，内置 gsplat.js 前端查看器。
4+
5+
[English](README.en.md) | [中文](README.md)
6+
7+
## 节点
8+
- Load Gaussian PLY：从 `input/`、`input/3d`、`output/` 下拉选择，支持自动分辨率、FOV 10–180°、可选透明度过滤。
9+
- Load Gaussian PLY (Path)：手动输入路径，具备同样的相机/自动分辨率选项。
10+
- Process Gaussian PLY：接收上游 `ply_path`（如 SHARP Predict），可覆盖相机或启用透明度过滤。
11+
- Preview Gaussian：gsplat.js WebGL 预览，提供缩放、重置、截图和信息面板。
12+
13+
## 特性
14+
- 自动分辨率：基于 FOV + target_scale，16 像素对齐，校准系数 0.8。
15+
- 透明度过滤：sigmoid 后按阈值过滤，减少背景噪点。
16+
- 输出相机内外参，预览一致性更好。
17+
- 宽 FOV（10–180°）含鱼眼场景。
18+
- 前端资源全部内置于 `web/`，无需外部依赖。
19+
20+
## 安装（Git clone）
21+
```bash
22+
cd ComfyUI/custom_nodes
23+
git clone https://github.com/XuanYu-github/comfyui-PlyPreview.git
24+
```
25+
重启 ComfyUI。
26+
27+
## 安装（ComfyUI Manager）
28+
在 Manager 中搜索 “comfyui-PlyPreview” 安装（内置 `comfyui_extension.json` 可被识别）。
29+
30+
## 使用方法
31+
1) 选择 Load 或 Process 节点，生成 `ply_path`、`extrinsics`、`intrinsics`。
32+
2) 连接 Preview Gaussian，执行后 iframe 显示控制条（Scale、Reset View、Screenshot）和信息面板。
33+
3) 若启用透明度过滤，会在源旁生成 `_opacity{threshold}.ply`。
34+
35+
## 依赖
36+
- ComfyUI（默认已启用 DOM widgets）。
37+
- Python：`plyfile`、`numpy`（缺失时 `pip install plyfile numpy`）。
38+
39+
## 备注
40+
- `WEB_DIRECTORY = "web"`，ComfyUI 会自动加载前端。
41+
- 节点前缀 `PlyPreview*`，避免与 GeometryPack 冲突。
42+
- 继承原 GeometryPack 的 GPL-3.0 许可。
43+
44+
## 许可
45+
GPL-3.0-or-later。详见 [LICENSE](LICENSE)。

0 commit comments

Comments
 (0)