Skip to main content

OpenComic AI Bin Documentation

Pre-built AI binaries for image upscaling, dehalftoning, and artifact removal. Integrate powerful image enhancement into your Node.js applications with a simple API.

What is OpenComic AI Bin?

OpenComic AI Bin provides pre-compiled binaries for Real-CUGAN, Real-ESRGAN, Waifu2x, and Upscayl, enabling AI-powered image processing directly from Node.js. Perfect for comic/manga upscaling, photo enhancement, and artifact removal.

Multiple AI Models

Choose from Real-CUGAN, Real-ESRGAN, Waifu2x, and Upscayl models for different use cases and quality levels.

Pipeline Processing

Chain multiple models together for advanced workflows like dehalftoning followed by upscaling.

Cross-Platform

Works on Linux, macOS, and Windows across x64 and ARM64 architectures with included binaries.

Daemon Mode

Load models once and process multiple images with up to 6.8x performance improvement.

Quick Start

Get started with OpenComic AI Bin in three simple steps.

1

Install the package

Install via npm, yarn, or pnpm:
npm install opencomic-ai-bin
2

Configure the library

Set up the models path and optionally configure for Electron apps:
import OpenComicAI from 'opencomic-ai-bin';

// Set models directory
OpenComicAI.setModelsPath('./models');

// For Electron apps, adjust binary paths
OpenComicAI.setDirname(
  OpenComicAI.__dirname.replace(/app(-(?:arm64|x64))?\.asar/, 'app$1.asar.unpacked')
);
3

Process your first image

Use the pipeline API to upscale an image:
await OpenComicAI.pipeline(
  './input.jpg',
  './output.jpg',
  [
    {
      model: 'realcugan',
      scale: 4,
      noise: 0
    }
  ],
  (progress) => {
    console.log(`Processing: ${Math.round(progress * 100)}%`);
  }
);
The models will download automatically on first use.

Key Features

Image Upscaling

Scale images up to 4x with AI models optimized for photos, illustrations, and anime content.

Dehalftoning

Remove halftone patterns from scanned comics and manga for cleaner digital versions.

Artifact Removal

Clean up JPEG compression artifacts and restore image quality.

Pipeline Processing

Combine multiple models for advanced workflows and custom processing chains.

Ready to get started?

Follow our quickstart guide to integrate AI-powered image processing into your application.

View Quickstart Guide

Build docs developers (and LLMs) love