https://github.com/j-siu/go-png2ico
PNG to ICO in GoLang. ICO store use PNG format.
https://github.com/j-siu/go-png2ico
go ico icon png
Last synced: about 1 month ago
JSON representation
PNG to ICO in GoLang. ICO store use PNG format.
- Host: GitHub
- URL: https://github.com/j-siu/go-png2ico
- Owner: J-Siu
- License: mit
- Created: 2020-08-17T13:05:55.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-09-15T19:57:00.000Z (about 1 year ago)
- Last Synced: 2024-10-19T17:28:20.572Z (about 1 year ago)
- Topics: go, ico, icon, png
- Language: Go
- Size: 45.9 KB
- Stars: 27
- Watchers: 4
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# go-png2ico [](https://www.paypal.com/donate/?business=HZF49NM9D35SJ&no_recurring=0¤cy_code=CAD)
Command line tool to create ICO(favicon) from PNG images.
### Table Of Content
- [Module](#module)
- [Install](#install)
- [Import](#import)
- [ICO Usage](#ico-usage)
- [Command Line](#command-line)
- [What It Does](#what-it-does)
- [What It Does Not](#what-it-does-not)
- [Limitation](#limitation)
- [Releases](#releases)
- [Go Install](#go-install)
- [Usage](#usage)
- [Repository](#repository)
- [Contributors](#contributors)
- [Change Log](#change-log)
- [License](#license)
### Module
#### Install
```sh
go get github.com/J-Siu/go-png2ico/v2
```
#### Import
```go
import "github.com/J-Siu/go-png2ico/v2/p2i"
```
#### ICO Usage
```go
// icoFile = ICO file to be created/overwritten
// ICO object must be initialized with New()
ico := new(p2i.ICO).New(icoFile)
// pngFile = PNG file path
// this steps can be repeated multiple times
ico.AddPngFile(pngFile)
// Create ICO file with all PNG loaded
ico.WriteAll()
```
Full example in [root.go](/cmd/root.go)
### Command Line
This package comes with command line front end.
#### What It Does
- Create ICO file from PNG files
- ICO use PNG format for storage
- Minimum overhead(16byte) per PNG added
- PNG header check for input files
- PNG header check for output file to avoid mistake
#### What It Does Not
- Change PNG to BMP inside ICO
- Check file extension
- Transform PNG
#### Limitation
- ICO file always created from scratch
- Will overwrite existing ICO file
- No append nor replace within existing ICO file
- PNG to ICO only, other format/conversion not supported
### Releases
https://github.com/J-Siu/go-png2ico/releases
### Go Install
```sh
go install github.com/J-Siu/go-png2ico/v2
```
### Usage
```sh
go-png2ico -h
```
```sh
Build ICO file from PNGs
Usage:
go-png2ico ... [flags]
Flags:
-d, --debug Enable debug
-h, --help help for go-png2ico
-v, --verbose Verbose
--version version for go-png2ico
```
### Repository
- [go-png2ico](https://github.com/J-Siu/go-png2ico)
### Contributors
- [John Sing Dao Siu](https://github.com/J-Siu)
### Change Log
- 1.0
- Initial Commit
- 1.0.1
- Fix
- debug log msg
- error check
- png detection
- 1.0.2
- Use mod
- 1.0.3
- Use github.com/J-Siu/go-helper
- 1.0.4
- Use Go 1.16
- v1.0.5
- Fix `goreleaser`
- v1.0.6
- Update to Go 1.20 and dependency
- v1.0.7
- Support PNG with height and width above 256
- v1.0.8
- Fix Github workflows
- v2.0.0
- expose ICO and PNG as package p2i
- move to go-helper/v2
- use cobra for cli flag
- v2.0.1
- resolve conflict
### License
The MIT License
Copyright (c) 2025 John Siu
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.