@hunlongyu/electron-icon-builder
TypeScript icon, indicating that this package has built-in type declarations

0.1.5 • Public • Published

electron-icon-builder

npm GitHub

Global Usage

// install
npm i -g @hunlongyu/electron-icon-builder

// usage
eib -i relative/path/file.png -o relative/path/folder

Local Usage

// install
npm i -D @hunlongyu/electron-icon-builder

// add a srcipt in package.json file
"scripts": {
    "icon": "eib  -i relative/path/file.png -o relative/path/folder"
}

// usage
npm run icon

Flags

--input,    -i [String]   [Default: './icon.png'] Path to PNG file, 
--output,   -o [String]   [Default: './build/']   Folder to create files, 
--flatten,  -f [Boolean]  [Default: false]        Flatten output struture

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]
    -[build]
        -[win]
            -icon.ico
        -[mac]
            - icon.icns
        -[png]
            - 16x16.png
            - 32x32.png
            - 18x18.png
            - 64x64.png
            - 128x128.png
            - 512x512.png

When flatten option is enabled

[output dir]
    -[build]
        - icon.icns
        - icon.ico
        - 16x16.png
        - 32x32.png
        - 48x48.png
        - 64x64.png
        - 128x128.png
        - 512x512.png

Package Sidebar

Install

npm i @hunlongyu/electron-icon-builder

Weekly Downloads

0

Version

0.1.5

License

MIT

Unpacked Size

10.8 kB

Total Files

12

Last publish

Collaborators

  • hunlongyu