Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sleitnick/png2ico
Cross-platform CLI tool to convert a list of PNG files into a single ICO file.
https://github.com/sleitnick/png2ico
cli ico icon png tool
Last synced: about 2 months ago
JSON representation
Cross-platform CLI tool to convert a list of PNG files into a single ICO file.
- Host: GitHub
- URL: https://github.com/sleitnick/png2ico
- Owner: Sleitnick
- License: mit
- Created: 2024-06-13T23:27:27.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-06-16T22:44:11.000Z (6 months ago)
- Last Synced: 2024-11-02T13:21:13.906Z (about 2 months ago)
- Topics: cli, ico, icon, png, tool
- Language: C
- Homepage:
- Size: 26.4 KB
- Stars: 5
- Watchers: 1
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# PNG to ICO
The `png2ico` command line tool converts a list of PNG files into a single ICO file.
## Install
Below are two diferent ways to install the tool.
### Manual Installation
1. Download the latest release binary for your given platform.
1. Extract the binary from the zip file.
1. Place the binary in your desired directory.
1. Point your path environment variable to the binary's location.
Test out the installation by outputting the version:
```sh
$ png2ico --version
```
### Aftman
Use [`aftman`](https://github.com/LPGhatguy/aftman) to install the binary.
```sh
aftman add Sleitnick/[email protected]
```
## Usage
```sh
# Convert a list of PNGs to a single ICO file:
$ png2ico output.ico input1.png [input2.png]...
# Output version
$ png2ico --version
# Output help
$ png2ico --help
```
## About
I needed to generate an ICO file for a Godot application. All the other tools to do so were terrible or hosted on sketchy websites built to generate ad revenue. I also wanted to learn some more C, hence why this is written in C and not some fancy new language. Nonetheless, the project is quite small.
This tool has been written specifically for the given task of generating an ICO file from a series of PNG files. There are no external libraries outside of the standard C library. The PNG decoder is only implemented to decode the necessary parts of the PNG in order to generate the ICO file. As such, the generated binary is nice and small.
## Build from Source
Run [`xmake`](https://xmake.io/) within the project's root directory.
```sh
$ xmake
```
Test the build:
```sh
$ xmake run png2ico --version
```
## Project Structure
| File | Description | Local Dependencies |
| ---- | ----------- | ------------ |
| `main` | Entry point and CLI management | _All_ |
| `ico` | ICO generator | `png`, `buffer`, `err` |
| `png` | PNG decoder | `buffer`, `err` |
| `err` | Shared error definitions | _None_ |
## Contributing
See something that's broken or insecure? Feel free to open up an issue and open up a PR. Pull requests without an attached issue will be declined.