Skip to content

README.md

Latest commit

 

History

History
443 lines (335 loc) · 15.6 KB

README.md

File metadata and controls

443 lines (335 loc) · 15.6 KB

🎨 ComfyUI TinyTerraLy Nodes

Professional ComfyUI Plotting & Visualization Nodes with Advanced Chinese Typography Support

ComfyUI Compatible Python License Nodes

Enhanced TinyTerra fork with perfect Chinese font rendering and professional typography

🌟 Key Features

✨ Core Capabilities

  • 🎯 Advanced XY Plotting - Professional grid layout generation
  • 🔤 Perfect Chinese Support - Intelligent font detection & rendering
  • 🎨 Complete Style Control - Colors, fonts, and size customization
  • 📐 Precise Layout - Full borders with overlap prevention
  • ⚡ Plug & Play - Included sample workflow

🚀 Technical Advantages

  • 🔍 2x Anti-aliasing - Crystal-clear text rendering
  • 🌐 Cross-platform - Win/Mac/Linux full support
  • 🔧 Smart Adaptation - Perfect ComfyUI latest version compatibility
  • 📝 Suffix Cleanup - Auto-optimized model name display
  • 🎛️ 14-Parameter Control - Pixel-perfect precision

📦 Installation

🎯 Method 1: ComfyUI Manager (Recommended)

  1. Open ComfyUI Manager
  2. Search for "TinyTerraLy" or "ttN"
  3. Click Install and restart ComfyUI

🔧 Method 2: Git Clone

cd ComfyUI/custom_nodes
git clone https://github.com/Ly-scnu/ComfyUI_TinyTerraLyNodes.git
# Restart ComfyUI

📁 Method 3: Manual Download

  1. Download this repository's ZIP file
  2. Extract to ComfyUI/custom_nodes/ComfyUI_TinyTerraLyNodes
  3. Restart ComfyUI

🎬 Preview

Node Interface

Node Interface

Generated Results

Generated Results

🚀 Quick Start

📋 Complete Workflow Package

🎉 This plugin includes a complete sample workflow!

📁 View Workflow File →

Usage Steps:

  1. Load Workflow: Drag workflow.json into ComfyUI
  2. Setup Models: Configure your checkpoints and other models
  3. Start Generation: Enjoy professional grid layouts

Workflow Features:

  • ✅ Pre-configured XY plotting setup
  • ✅ Optimized Chinese font parameters
  • ✅ Professional color schemes
  • ✅ Multiple parameter variation examples

🎨 Node Usage Guide

Find Nodes: Look for ttN → xyPlot → advPlot images in your node browser

Basic Setup:

  1. Connect image grid input
  2. Configure plotting parameters
  3. Adjust font and color settings

📋 Node Details

Core Nodes

Node Name Category Description
ttN advPlot images ttN/xyPlot Advanced XY plotting with Chinese font support
ttN advanced xyPlot ttN/xyPlot Enhanced plotting parameter control

Parameter Reference

Parameter Type Default Description
background_color Dropdown "white" Background color selection
text_color Dropdown "black" Text color selection
font_size_mode Dropdown "Auto" Font mode (Auto/Fixed)
x_font_size Slider 32 X-axis font size (12-100)
y_font_size Slider 32 Y-axis font size (12-100)
z_font_size Slider 32 Z-axis font size (12-100)
chinese_font Dropdown "方正仿宋" Chinese font selection
english_font Dropdown "Times New Roman" English font selection

🔧 Core Improvements

🎯 Major Contribution: Perfect Latest ComfyUI Ecosystem Adaptation

  • 🔧 ComfyUI v0.345+ Full Compatibility - Adapted for 2025 latest version, resolving original incompatibility issues
  • 🚀 Nunchaku & Flux Kontext Support - Perfect adaptation for latest AI toolchain
  • 🌟 Forward Compatibility Guarantee - Ensures continued compatibility with future versions

🌏 Core Pain Points Resolved

Issues with Original Version:

  • ❌ Chinese Display Squares/Garbled - Lack of Chinese font support
  • ❌ Inconsistent Font Sizes - "Large and small" affecting aesthetics
  • ❌ Incomplete Borders - Missing right border
  • ❌ Version Compatibility Issues - Conflicts with new ComfyUI

Our Solutions:

  • ✅ Professional Chinese Font Rendering - Intelligent language detection + FangZheng FangSong font
  • ✅ Unified Font Control System - X/Y/Z axis independent size control, goodbye to clutter
  • ✅ Complete Four-sided Borders - Rewritten layout algorithm ensuring visual integrity
  • ✅ 2x Anti-aliasing Technology - Goodbye to blurry text, enjoy crystal-clear display

✨ New Feature Highlights

🎯 Chinese Font Support

Personal Need: Improve Chinese model name display

Intelligent Bilingual Font Rendering

  • Automatic Language Detection: Auto-switches Chinese font when Chinese characters >30%
  • Professional Chinese Fonts: FangZheng FangSong/Microsoft YaHei/SimSun/SimHei options
  • Elegant English Fonts: Times New Roman/Arial/Calibri/Consolas options
  • Mixed Text Support: Chinese-English mixed display, best of both worlds

High-Quality Rendering Technology

  • 2x Supersampling Anti-aliasing: Eliminates text edge aliasing, crystal-clear clarity
  • LANCZOS High-Quality Scaling: Ensures sharp effects at any size
  • Smart Suffix Cleanup: Auto-removes .safetensors, .ckpt etc. suffixes

🌈 Color Selection Extensions

Convenience Feature: Provides more background and text color options

Background Color RGB Value Recommended Use Best Text Color
White (255,255,255) Classic light theme Black
Black (0,0,0) Professional dark theme White
Dark Gray (64,64,64) Modern professional style White
Light Gray (192,192,192) Soft neutral theme Black
Blue (70,130,180) Technical demonstrations White

🔧 Font Size Control

Unified Display: Resolves font size inconsistency issues

New Control Options

  • font_size_mode: Auto(original) / Fixed(fixed)
  • x_font_size: X-axis font size (12-100)
  • y_font_size: Y-axis font size (12-100)
  • z_font_size: Z-axis font size (12-100)
  • Overlap Prevention: Auto-adjusts when fonts too large
  • Center Alignment: Label position optimization

📦 Complete Feature Setup (Recommended)

Basic Installation

After installation, basic features are immediately available, including Chinese font support and all core features.

Advanced Font System (Optional)

# Enter plugin directory
cd ComfyUI_TinyTerraLyNodes/fonts

# Install font management system (get FangZheng FangSong and other advanced fonts)
python install_fonts.py

# Preview all available font effects
python font_samples.py

🔧 Compatibility Test Report

Component Version Requirement Test Status Notes
ComfyUI v0.345+ ✅ Full Support 2025 latest version thoroughly tested
Flux Kontext All versions ✅ Enhanced Adaptation Specially optimized compatibility support
Nunchaku All versions ✅ Enhanced Adaptation Perfect support for latest features
Python 3.8+ ✅ Supported Cross-platform compatible
Operating System Win/Mac/Linux ✅ All Platforms Font system auto-adaptation

🎯 Real-World Use Cases

Case 1: Professional Dark Theme Charts

Background: Black
Text Color: White  
Font Mode: Fixed
X-axis Font: 28
Y-axis Font: 28
Chinese Font: FangZheng FangSong
English Font: Times New Roman

Effect: "Black Myth Wukong Style1" displays clearly, uniform font size, professional appearance

Case 2: Chinese-English Mixed Technical Documentation Style

Background: Light Gray
Text Color: Black
Font Mode: Fixed
All Axis Fonts: 24
Chinese Font: Microsoft YaHei
English Font: Calibri

Effect: Suitable for technical documentation, Chinese and English each with distinct characteristics, modern minimalist style

📋 Complete Parameter Control Panel

🎛️ advPlot Enhanced Node Parameters (14 Precise Control Items)

Parameter Type Default Description New
enabled Boolean True Node enable switch -
image IMAGE - Input image grid -
image_output Dropdown "Preview" Output mode selection -
save_prefix String "advPlot" Save file prefix -
file_type Dropdown "png" File format -
embed_workflow Boolean True Embed workflow -
background_color Dropdown "Black" Background color ✅ New
text_color Dropdown "White" Text color ✅ New
font_size_mode Dropdown "Auto" Font mode ✅ New
x_font_size Slider 32 X-axis font size (12-100) ✅ New
y_font_size Slider 32 Y-axis font size (12-100) ✅ New
z_font_size Slider 32 Z-axis font size (12-100) ✅ New
chinese_font Dropdown "方正仿宋" Chinese font selection ✅ New
english_font Dropdown "Times New Roman" English font selection ✅ New

🔍 Parameter Details

Font Mode Comparison

  • Auto Mode: Original behavior, font size auto-adapts to text length
  • Fixed Mode: Uniform font size, goodbye to "large and small" inconsistency

Smart Protection Mechanisms

  • Overlap Detection: Auto-fallback when fonts too large in Fixed mode
  • Backward Compatibility: Existing workflows need no modification, seamless upgrade
  • Cross-platform Adaptation: Font auto-fallback ensures compatibility

🏗️ Extensible Font Management System

📁 Project Structure

ComfyUI_TinyTerraLyNodes/
├── fonts/
│   ├── font_config.json      # Font configuration core
│   ├── install_fonts.py      # Font installation tool
│   ├── font_samples.py       # Font preview generator
│   ├── README.md            # Font system documentation
│   └── FZFSK.TTF            # FangZheng FangSong font file
├── ttNpy/                    # Core code
└── README.md                # Main documentation

⚙️ Advanced User Guide

Adding Custom Fonts

  1. Add Font Files: Copy .ttf files to fonts/ directory
  2. Modify Configuration: Edit fonts/font_config.json
{
  "fonts": {
    "chinese": [
      {"name": "Your Font", "file": "YourFont.ttf"}
    ]
  }
}
  1. Install Fonts: Run python install_fonts.py
  2. Restart ComfyUI: New fonts will appear in dropdown menu

Font Preview Tool

cd fonts/
python font_samples.py
# Generate preview images of all fonts for easy selection

🛠️ Technical Implementation Details

🔧 Major Improvement Methods

🚀 Core Technical Innovations

  • Intelligent Language Detection Algorithm - Auto-switch when Chinese characters >30%
  • 2x Supersampling Anti-aliasing - Eliminates text aliasing, crystal-level clarity
  • LANCZOS High-Quality Scaling - Ensures sharp effects at any size
  • Layout Algorithm Reconstruction - Resolves border missing issues

🔧 Engineering Achievements

  • 14-Parameter Precision Control - Pixel-level customization capability
  • Smart Fallback Mechanism - Auto-protection against overlap
  • Cross-platform Font System - Win/Mac/Linux full compatibility
  • Backward Compatible Design - Seamless upgrade guarantee

🛠️ Specific Problem Resolution Comparison

Issue Type Original Status Enhanced Solution Actual Effect
Chinese Display ❌ Squares/Garbled ✅ Smart font selection "Chinese fonts" display perfectly
Font Size ❌ Large-small inconsistency ✅ Fixed mode unified control All labels same size, professional appearance
Layout Borders ❌ Missing right border ✅ Rewritten layout algorithm Complete four-sided borders
File Suffixes ❌ .safetensors display ✅ Smart suffix cleanup "Model1" instead of "Model1.safetensors"
Version Compatibility ❌ New ComfyUI conflicts ✅ v0.345+ full adaptation Zero conflict stable operation

🎓 Learning Achievements & Open Source Spirit

💝 Acknowledgments & Respect

First, our sincere thanks to the original author TinyTerra!

This enhanced version is built entirely on TinyTerra's excellent foundational architecture. We:

  • ✅ Respect Original: Maintain original core functionality integrity
  • ✅ Extend & Enhance: Add new features without breaking original version
  • ✅ Learning-Oriented: Motivated by learning and community contribution
  • ✅ Open Source Giving Back: Share improvements with entire community

🎯 Project Motivation

  • 📚 Learning Practice: Improve programming and UI design skills through actual projects
  • 🌏 Solve Pain Points: Improve Chinese user experience in ComfyUI
  • 🤝 Community Contribution: Give back learning results to the open source community that helped us
  • 🔧 Technical Exploration: Explore adaptation and optimization of cutting-edge AI tools

🚀 Quick Start Guide

Step 1: Install and Restart

cd ComfyUI/custom_nodes
git clone https://github.com/Ly-scnu/ComfyUI_TinyTerraLyNodes.git
cd ComfyUI_TinyTerraLyNodes/fonts
python install_fonts.py  # Install font system
# Restart ComfyUI

Step 2: Test Enhanced Features

  1. Find Node: ttN → xyPlot → advPlot images
  2. Recommended Settings: 
    📍 Background: Black
📍 Text Color: White
📍 Font Mode: Fixed
📍 Chinese Font: FangZheng FangSong
📍 English Font: Times New Roman
📍 All Axis Font Size: 28
  3. Test Effect: Use model names containing Chinese, like "Black Myth Wukong Style"

Step 3: Enjoy Professional Results

✅ Chinese model names display clearly
✅ Unified coordinated font sizes
✅ Complete four-sided borders
✅ Professional color coordination

🎉 Support Our Learning Journey

🌟 Star This Project

If our enhancements help your workflow, please ⭐ star this repository to support student learning in open source!

🤝 Contribute

  • Report Issues: Help us learn by reporting bugs
  • Suggest Features: Share ideas for typography and UX improvements
  • Share Fonts: Contribute fonts to our community collection
  • Improve Documentation: Help enhance our learning resources

💖 Original Support

Love the original TinyTerra foundation? Buy TinyTerra a coffee ☕

Made with 💚 for learning, sharing, and growing together

🎓 Student Project • 🌍 Open Source • 🤝 Community Driven

GitHub Issues PRs Welcome