docs: clarify ComfyUI-KJNodes dependency requirement

- Add clear import error message when comfy_api.latest is missing
- Update README installation instructions to require KJNodes first
- Update troubleshooting section with dependency check
- Remove misleading statement that KJNodes is not needed

Co-authored-by: Cursor Agent <cursoragent@cursor.com>
This commit is contained in:
by-ae
2026-10-25 20:58:11 +00:00
co-authored by Cursor Agent
parent c5ec465cd7
commit 0ff49ca24e
3 changed files with 30 additions and 6 deletions
@@ -0,0 +1,11 @@
{
"TestChar": {
"desc": "A test"
},
"Hero": {
"desc": "Main character",
"palette": [
"#FF0000"
]
}
}
+11 -5
View File
@@ -27,14 +27,19 @@ I may add other Ideogram 4 tools here in future, hence the name.
## Installation
1. Clone into `ComfyUI/custom_nodes/`:
1. Install [ComfyUI-KJNodes](https://github.com/kijai/ComfyUI-KJNodes) (required dependency):
```bash
# open a terminal in the ComfyUI/custom_nodes directory
# In ComfyUI/custom_nodes directory
git clone https://github.com/kijai/ComfyUI-KJNodes.git
```
2. Clone this repository into `ComfyUI/custom_nodes/`:
```bash
# In ComfyUI/custom_nodes directory
git clone https://github.com/by-ae/ComfyUI-ByAE-IdeogramTools.git
```
2. Restart ComfyUI
**ComfyUI-KJNodes does not need to be installed.**
3. Restart ComfyUI
## Usage
@@ -49,8 +54,9 @@ The builder outputs a structured JSON prompt compatible with Ideogram 4's API fo
### Nodes don't appear in the menu
- Ensure ComfyUI-KJNodes is installed first (required dependency)
- Ensure ComfyUI restarted completely after cloning
- Check the ComfyUI console for import errors
- Check the ComfyUI console for import errors (look for "requires ComfyUI-KJNodes" message)
- Verify the folder is named `ComfyUI-ByAE-IdeogramTools` (not `ComfyUI-ByAE-IdeogramTools-main`)
### "Failed to load stores" or route errors in console
+8 -1
View File
@@ -22,7 +22,14 @@ def _bg_log(msg, *args):
_BG_LOG.info("%s", line)
print(line, flush=True)
from comfy_api.latest import io
try:
from comfy_api.latest import io
except ImportError as e:
raise ImportError(
"ComfyUI-ByAE-IdeogramTools requires ComfyUI-KJNodes to be installed. "
"Please install it from https://github.com/kijai/ComfyUI-KJNodes. "
f"Import error: {e}"
) from e
PREVIEW_PALETTE = ["#46b4e6", "#e68246", "#82e646", "#e646b4", "#e6e646", "#46e6c8"]
_FONT_PATH = os.path.join(os.path.dirname(os.path.dirname(__file__)), "fonts", "FreeMono.ttf")