# Generate ICONS

**Repository Path**: tufeiping/generate-icon

## Basic Information

- **Project Name**: Generate ICONS
- **Description**: 简单的命令行（NodeJS），生成多种尺寸ICONS的工具
- **Primary Language**: NodeJS
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-06-06
- **Last Updated**: 2025-06-06

## Categories & Tags

**Categories**: javascript-toolkits

**Tags**: None

## README

# 图标生成器

一个交互式图标转换工具，用于生成PWA应用所需的各种尺寸的图标。

## 功能特点

- 支持多种输入格式（SVG、PNG、JPG/JPEG）
- 智能图像处理和缩放
- 可选择透明或白色背景
- 生成多种尺寸的PNG格式图标（16px, 32px, 192px, 512px）
- 支持生成带有安全区域的Maskable图标
- 自动生成favicon.ico文件
- 交互式命令行界面
- 自动创建时间戳目录，避免文件覆盖
- 支持一键打开输出目录

![screenshot](./screenshot.png)

## 安装

```bash
npm install
```

## 使用方法

1. 运行程序：
```bash
npm start
```

2. 根据提示输入图片文件路径（支持SVG、PNG、JPG格式）

3. 选择是否使用透明背景（默认为白色背景）
   - 选择 'y': 生成透明背景的图标（适用于深色模式）
   - 选择 'n': 生成白色背景的图标（默认选项）

4. 程序会在 `output/icons-{时间戳}` 目录下生成以下文件：
   - icon-192.png
   - icon-512.png
   - icon-192-maskable.png
   - icon-512-maskable.png
   - favicon-16.png
   - favicon-32.png
   - favicon.ico
   - 原始图片文件的副本

5. 生成完成后，可以选择直接在文件管理器中打开输出目录

## 输出目录结构

```
output/
  └── icons-2024-03-21-10-30-45/  # 示例时间戳目录
      ├── icon-192.png
      ├── icon-512.png
      ├── icon-192-maskable.png
      ├── icon-512-maskable.png
      ├── favicon-16.png
      ├── favicon-32.png
      ├── favicon.ico
      └── 原始图片文件
```

## 图像处理特性

- 智能缩放：保持图像比例，自动适应目标尺寸
- 透明度处理：可选择透明或白色背景
- 安全区域：自动为Maskable图标添加10%的安全边距
- 高质量输出：使用高质量的图像处理算法

## 注意事项

- 确保系统已安装 Node.js (建议版本 >= 14)
- 支持的输入格式：SVG、PNG、JPG/JPEG
- 每次运行都会创建新的时间戳目录，不会覆盖之前的文件
- Maskable图标会自动添加10%的安全区域，适用于Android自适应图标
- 透明背景选项不影响Maskable图标（始终使用白色背景）
- 建议使用分辨率较高的图片作为输入源，以确保最佳输出质量
- 支持Windows、macOS和Linux系统