Skip to main content

​
Install the package

Install OpenComic AI Bin using your preferred package manager: 
npm install opencomic-ai-bin

​
System requirements

​
Platform support

OpenComic AI Bin provides pre-built binaries for multiple platforms and architectures:
  • macOS: x64 and arm64 (Apple Silicon)
  • Windows: x64 and arm64
  • Linux: x64 and arm64
The package includes binaries for Real-CUGAN, Waifu2x, and Upscayl upscalers. Models are downloaded automatically when needed, so you don’t need to install them separately.

​
GPU acceleration

All included binaries use Vulkan for GPU acceleration. Ensure your system has Vulkan support for optimal performance:
  • macOS: Built-in support via MoltenVK
  • Windows: Install latest GPU drivers
  • Linux: Install vulkan-tools and GPU-specific Vulkan drivers

​
Optional dependencies

​
ICC profile support with sharp

To preserve ICC color profiles when processing images, install the sharp package: 
npm install sharp
Once installed, configure OpenComic AI Bin to use sharp for ICC profile preservation: 
import OpenComicAI from 'opencomic-ai-bin';
import sharp from 'sharp';

OpenComicAI.keepIccProfile(sharp);
ICC profile preservation is optional. If you don’t need color profile management, you can skip installing sharp.

​
Next steps

Quickstart

Get started with your first image upscaling example

Build docs developers (and LLMs) love

Get started for freeTalk to us