Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jackmordaunt/icns
Easily create .icns files (Mac Icons) with this Go library or the included CLI.
https://github.com/jackmordaunt/icns
cli go golang icns icons iconset iconutil library macos osx retina
Last synced: 3 days ago
JSON representation
Easily create .icns files (Mac Icons) with this Go library or the included CLI.
- Host: GitHub
- URL: https://github.com/jackmordaunt/icns
- Owner: JackMordaunt
- License: mit
- Created: 2018-02-12T14:05:28.000Z (almost 7 years ago)
- Default Branch: v3
- Last Pushed: 2024-10-29T04:25:27.000Z (3 months ago)
- Last Synced: 2025-01-13T08:02:52.327Z (17 days ago)
- Topics: cli, go, golang, icns, icons, iconset, iconutil, library, macos, osx, retina
- Language: Go
- Homepage: https://liberapay.com/JackMordaunt
- Size: 207 KB
- Stars: 83
- Watchers: 3
- Forks: 5
- Open Issues: 5
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
# icns
Easily convert `.jpg` and `.png` to `.icns` with the command line tool `icnsify`, or use the library to convert from any `image.Image` to `.icns`.
`go get github.com/jackmordaunt/icns`
`icns` files allow for high resolution icons to make your apps look sexy. The most common ways to generate icns files are:
1. `iconutil`, which is a Mac native cli utility.
2. `ImageMagick` which adds a large dependency to your project for such a simple use case.
With this library you can use pure Go to create `icns` files from any source image, given that you can decode it into an `image.Image`, without any heavyweight dependencies or subprocessing required. You can also use it to create icns files on windows and linux (thanks Go).
A small CLI app `icnsify` is provided allowing you to create icns files using this library from the command line. It supports piping, which is something `iconutil` does not do, making it substantially easier to wrap or chuck into a shell pipeline.
Note: All icons within the `icns` are sized for high dpi retina screens, using the appropriate `icns` OSTypes.
## GUI
`preview` is a gui for displaying `icns` files cross-platform.
### Go Tool
```
go install github.com/jackmordaunt/icns/cmd/preview@latest
```
### Clone
```
git clone https://github.com/jackmordaunt/icns
cd icns/cmd/preview && go install .
```
Note: Gio cannot be cross-compiled right now, so there are no `preview` builds in releases.
Note: `preview` has it's own `go.mod` and therefore is versioned independently (unversioned).
## Command Line
### Go Tool
```
go install github.com/jackmordaunt/icns/cmd/icnsify@latest
```
### [Scoop](https://scoop.sh/)
```powershell
scoop bucket add extras # Ensure bucket is added first
scoop install icnsify
```
Or from my personal bucket:
```powershell
scoop bucket add jackmordaunt https://github.com/jackmordaunt/scoop-bucket
scoop install jackmordaunt/icns # Name is defaulted to repo name.
```
### [Winget](https://learn.microsoft.com/en-us/windows/package-manager/)
```powershell
winget install icnsify
```
### [Brew](https://brew.sh)
```sh
brew tap jackmordaunt/homebrew-tap # Ensure tap is added first.
brew install icnsify
```
### Clone
```
git clone https://github.com/jackmordaunt/icns
cd icns && go install ./cmd/icnsify
```
Pipe it
`cat icon.png | icnsify > icon.icns`
`cat icon.icns | icnsify > icon.png`
Standard
`icnsify -i icon.png -o icon.icns`
`icnsify -i icon.icns -o icon.png`
## Library
`go get github.com/jackmordaunt/icns/v3`
```go
func main() {
pngf, err := os.Open("path/to/icon.png")
if err != nil {
log.Fatalf("opening source image: %v", err)
}
defer pngf.Close()
srcImg, _, err := image.Decode(pngf)
if err != nil {
log.Fatalf("decoding source image: %v", err)
}
dest, err := os.Create("path/to/icon.icns")
if err != nil {
log.Fatalf("opening destination file: %v", err)
}
defer dest.Close()
if err := icns.Encode(dest, srcImg); err != nil {
log.Fatalf("encoding icns: %v", err)
}
}
```
## Roadmap
- [x] Encoder: `image.Image -> .icns`
- [x] Command Line Interface
- [x] Encoding
- [x] Pipe support
- [x] Decoding
- [x] Implement Decoder: `.icns -> image.Image`
- [ ] Symmetric test: `decode(encode(img)) == img`
## Coffee
If this software is useful to you, consider buying me a coffee!
[https://liberapay.com/JackMordaunt](https://liberapay.com/JackMordaunt)