https://github.com/safu9/electron-icon-builder

An icon generator to generate all the icon files needed for electron packaging
https://github.com/safu9/electron-icon-builder

electron electron-builder electron-packager icon

Last synced: 3 months ago
JSON representation

An icon generator to generate all the icon files needed for electron packaging

• Host: GitHub
• URL: https://github.com/safu9/electron-icon-builder
• Owner: safu9
• License: mit
• Fork: true (jaretburkett/electron-icon-maker)
• Created: 2018-11-24T03:54:13.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2022-12-08T14:33:18.000Z (almost 2 years ago)
• Last Synced: 2024-07-19T18:44:47.402Z (4 months ago)
• Topics: electron, electron-builder, electron-packager, icon
• Language: JavaScript
• Size: 515 KB
• Stars: 132
• Watchers: 2
• Forks: 17
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-github-star - electron-icon-builder

README

        
# electron-icon-builder

[![npm](https://img.shields.io/npm/v/electron-icon-builder?color=success)](https://www.npmjs.com/package/electron-icon-builder)

[![node](https://img.shields.io/node/v/electron-icon-builder)](https://www.npmjs.com/package/electron-icon-builder)

[![dependencies status](https://img.shields.io/david/safu9/electron-icon-builder)](https://david-dm.org/safu9/electron-icon-builder)

An icon generator to generate all the icon files needed for electron packaging

## Global usage

Install globally using

```

npm install -g electron-icon-builder

```

To use

```

electron-icon-builder --input=/absolute/path/file.png --output=./relative/path/to/folder

```

## Local usage

Install locally

```

npm install --save-dev electron-icon-builder

```

To use

```

./node_modules/.bin/electron-icon-builder --input=/absolute/path/file.png --output=./relative/path/to/folder

```

## Arguments

```

--output, -o = [String] Folder to create files

--input, -i = [String] Path to PNG file

--flatten, -f  Flatten output structure

```

## Recommendations

Input file should be 1024px x 1024px or larger. Make sure it is a 1 to 1 aspect ratio on width to height.

## Output structure

```

[output dir]

    -[icons]

        -[mac]

            - icon.icns

        -[png]

            - 16x16.png

            - 24x24.png

            ...

            ...

            - 512x512.png

            - 1024x1024.png

        -[win]

            -icon.ico

```

When flatten option is enabled

```

[output dir]

    -[icons]

        - icon.icns

        - icon.ico

        - 16x16.png

        - 24x24.png

        ...

        ...

        - 512x512.png

        - 1024x1024.png

```