From 16f1e2ebc6b0e6dd2d409ff04853f936ed2a986b Mon Sep 17 00:00:00 2001 From: XuanYu-github Date: Mon, 29 Dec 2025 01:06:50 +0800 Subject: [PATCH] Docs: make Chinese default README --- README.en.md | 45 +++++++++++++++++++++++++++++++++++++ README.md | 60 +++++++++++++++++++++++++------------------------ README.zh-CN.md | 45 +++++++++++++++++++++++++++++++++++++ 3 files changed, 121 insertions(+), 29 deletions(-) create mode 100644 README.en.md create mode 100644 README.zh-CN.md diff --git a/README.en.md b/README.en.md new file mode 100644 index 0000000..723fc24 --- /dev/null +++ b/README.en.md @@ -0,0 +1,45 @@ +# ComfyUI PlyPreview + +[中文](README.md) | [English](README.en.md) + +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. + +## Nodes +- Load Gaussian PLY — dropdown from `input/`, `input/3d`, `output/` with auto-resolution, FOV 10–180°, optional opacity filter. +- Load Gaussian PLY (Path) — manual path entry with the same camera/auto-res options. +- Process Gaussian PLY — accept upstream `ply_path` (e.g., SHARP Predict) with camera override/opacity filter. +- Preview Gaussian — gsplat.js WebGL viewer with scale slider, reset, screenshot, info panel. + +## Features +- Auto resolution from FOV + target scale (rounded to 16px, calibration factor 0.8). +- Opacity filtering (sigmoid) with threshold. +- Camera intrinsics/extrinsics outputs for consistent preview. +- Wide FOV (10–180°) including fisheye cases. +- Fully self-contained: viewer HTML/JS bundled under `web/`. + +## Install (Git clone) +```bash +cd ComfyUI/custom_nodes +git clone https://github.com/XuanYu-github/comfyui-PlyPreview.git +``` +Restart ComfyUI. + +## Install (ComfyUI Manager) +Search for “comfyui-PlyPreview” in Manager and install. (This repo ships `comfyui_extension.json` so Manager can detect it.) + +## Usage +1) Use one of the Load nodes or Process node to produce `ply_path`, `extrinsics`, `intrinsics`. +2) Connect to Preview Gaussian. After execution the viewer iframe shows controls (Scale, Reset View, Screenshot) and info panel. +3) If opacity filtering is enabled, a filtered PLY is written alongside the source (suffix `_opacity{threshold}.ply`). + +## Requirements +- ComfyUI recent build with DOM widgets enabled (standard). +- Python deps: `plyfile`, `numpy` (install via your ComfyUI environment). Most ComfyUI setups already have numpy; install plyfile if missing: `pip install plyfile`. + +## Notes +- WEB_DIRECTORY is set to `web` so ComfyUI loads the bundled frontend automatically. +- Namespaces are prefixed `PlyPreview*` to avoid collision with GeometryPack. +- Original GeometryPack license is GPL-3.0; this fork keeps the same license. + +## License +GPL-3.0-or-later. See [LICENSE](LICENSE). diff --git a/README.md b/README.md index 45abdd9..30cbc3c 100644 --- a/README.md +++ b/README.md @@ -1,43 +1,45 @@ # ComfyUI PlyPreview -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. +[中文](README.md) | [English](README.en.md) -## Nodes -- Load Gaussian PLY — dropdown from `input/`, `input/3d`, `output/` with auto-resolution, FOV 10–180°, optional opacity filter. -- Load Gaussian PLY (Path) — manual path entry with the same camera/auto-res options. -- Process Gaussian PLY — accept upstream `ply_path` (e.g., SHARP Predict) with camera override/opacity filter. -- Preview Gaussian — gsplat.js WebGL viewer with scale slider, reset, screenshot, info panel. +Gaussian Splat PLY 加载与预览节点,独立于 GeometryPack,内置 gsplat.js 前端查看器。 -## Features -- Auto resolution from FOV + target scale (rounded to 16px, calibration factor 0.8). -- Opacity filtering (sigmoid) with threshold. -- Camera intrinsics/extrinsics outputs for consistent preview. -- Wide FOV (10–180°) including fisheye cases. -- Fully self-contained: viewer HTML/JS bundled under `web/`. +## 节点 +- Load Gaussian PLY:从 `input/`、`input/3d`、`output/` 下拉选择,支持自动分辨率、FOV 10–180°、可选透明度过滤。 +- Load Gaussian PLY (Path):手动输入路径,具备同样的相机/自动分辨率选项。 +- Process Gaussian PLY:接收上游 `ply_path`(如 SHARP Predict),可覆盖相机或启用透明度过滤。 +- Preview Gaussian:gsplat.js WebGL 预览,提供缩放、重置、截图和信息面板。 -## Install (Git clone) +## 特性 +- 自动分辨率:基于 FOV + target_scale,16 像素对齐,校准系数 0.8。 +- 透明度过滤:sigmoid 后按阈值过滤,减少背景噪点。 +- 输出相机内外参,预览一致性更好。 +- 宽 FOV(10–180°)含鱼眼场景。 +- 前端资源全部内置于 `web/`,无需外部依赖。 + +## 安装(Git clone) ```bash cd ComfyUI/custom_nodes git clone https://github.com/XuanYu-github/comfyui-PlyPreview.git ``` -Restart ComfyUI. +重启 ComfyUI。 -## Install (ComfyUI Manager) -Search for “comfyui-PlyPreview” in Manager and install. (This repo ships `comfyui_extension.json` so Manager can detect it.) +## 安装(ComfyUI Manager) +在 Manager 中搜索 “comfyui-PlyPreview” 安装(内置 `comfyui_extension.json` 可被识别)。 -## Usage -1) Use one of the Load nodes or Process node to produce `ply_path`, `extrinsics`, `intrinsics`. -2) Connect to Preview Gaussian. After execution the viewer iframe shows controls (Scale, Reset View, Screenshot) and info panel. -3) If opacity filtering is enabled, a filtered PLY is written alongside the source (suffix `_opacity{threshold}.ply`). +## 使用方法 +1) 选择 Load 或 Process 节点,生成 `ply_path`、`extrinsics`、`intrinsics`。 +2) 连接 Preview Gaussian,执行后 iframe 显示控制条(Scale、Reset View、Screenshot)和信息面板。 +3) 若启用透明度过滤,会在源旁生成 `_opacity{threshold}.ply`。 -## Requirements -- ComfyUI recent build with DOM widgets enabled (standard). -- Python deps: `plyfile`, `numpy` (install via your ComfyUI environment). Most ComfyUI setups already have numpy; install plyfile if missing: `pip install plyfile`. +## 依赖 +- ComfyUI(默认已启用 DOM widgets)。 +- Python:`plyfile`、`numpy`(缺失时 `pip install plyfile numpy`)。 -## Notes -- WEB_DIRECTORY is set to `web` so ComfyUI loads the bundled frontend automatically. -- Namespaces are prefixed `PlyPreview*` to avoid collision with GeometryPack. -- Original GeometryPack license is GPL-3.0; this fork keeps the same license. +## 备注 +- `WEB_DIRECTORY = "web"`,ComfyUI 会自动加载前端。 +- 节点前缀 `PlyPreview*`,避免与 GeometryPack 冲突。 +- 继承原 GeometryPack 的 GPL-3.0 许可。 -## License -GPL-3.0-or-later. See [LICENSE](LICENSE). +## 许可 +GPL-3.0-or-later。详见 [LICENSE](LICENSE)。 diff --git a/README.zh-CN.md b/README.zh-CN.md new file mode 100644 index 0000000..adbf5b4 --- /dev/null +++ b/README.zh-CN.md @@ -0,0 +1,45 @@ +# ComfyUI PlyPreview + +Gaussian Splat PLY 加载与预览节点,独立于 GeometryPack,内置 gsplat.js 前端查看器。 + +[English](README.en.md) | [中文](README.md) + +## 节点 +- Load Gaussian PLY:从 `input/`、`input/3d`、`output/` 下拉选择,支持自动分辨率、FOV 10–180°、可选透明度过滤。 +- Load Gaussian PLY (Path):手动输入路径,具备同样的相机/自动分辨率选项。 +- Process Gaussian PLY:接收上游 `ply_path`(如 SHARP Predict),可覆盖相机或启用透明度过滤。 +- Preview Gaussian:gsplat.js WebGL 预览,提供缩放、重置、截图和信息面板。 + +## 特性 +- 自动分辨率:基于 FOV + target_scale,16 像素对齐,校准系数 0.8。 +- 透明度过滤:sigmoid 后按阈值过滤,减少背景噪点。 +- 输出相机内外参,预览一致性更好。 +- 宽 FOV(10–180°)含鱼眼场景。 +- 前端资源全部内置于 `web/`,无需外部依赖。 + +## 安装(Git clone) +```bash +cd ComfyUI/custom_nodes +git clone https://github.com/XuanYu-github/comfyui-PlyPreview.git +``` +重启 ComfyUI。 + +## 安装(ComfyUI Manager) +在 Manager 中搜索 “comfyui-PlyPreview” 安装(内置 `comfyui_extension.json` 可被识别)。 + +## 使用方法 +1) 选择 Load 或 Process 节点,生成 `ply_path`、`extrinsics`、`intrinsics`。 +2) 连接 Preview Gaussian,执行后 iframe 显示控制条(Scale、Reset View、Screenshot)和信息面板。 +3) 若启用透明度过滤,会在源旁生成 `_opacity{threshold}.ply`。 + +## 依赖 +- ComfyUI(默认已启用 DOM widgets)。 +- Python:`plyfile`、`numpy`(缺失时 `pip install plyfile numpy`)。 + +## 备注 +- `WEB_DIRECTORY = "web"`,ComfyUI 会自动加载前端。 +- 节点前缀 `PlyPreview*`,避免与 GeometryPack 冲突。 +- 继承原 GeometryPack 的 GPL-3.0 许可。 + +## 许可 +GPL-3.0-or-later。详见 [LICENSE](LICENSE)。