Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zephyros1938/png-maker
A Node.js script to make PNGS with
https://github.com/zephyros1938/png-maker
node node-js nodejs png png-image-generate
Last synced: 9 days ago
JSON representation
A Node.js script to make PNGS with
- Host: GitHub
- URL: https://github.com/zephyros1938/png-maker
- Owner: Zephyros1938
- License: gpl-3.0
- Created: 2024-05-02T13:12:47.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-05-04T02:53:12.000Z (9 months ago)
- Last Synced: 2024-11-13T20:41:27.696Z (2 months ago)
- Topics: node, node-js, nodejs, png, png-image-generate
- Language: JavaScript
- Homepage:
- Size: 69.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# PNG Generator
## Overview
This repository contains a Node.js script for generating PNG files with customizable dimensions, bit depths, and color types.
The script utilizes libraries such as `crc`, `zlib`, and `fs` for PNG generation.
## Setup
1. Clone this repository to your local machine.
2. Install Node.js if you haven't already.
3. Install the required dependencies using `npm install`.
## Usage
To generate a PNG file, use the `CREATEPNG` function provided in the `main.js` file. Here's how to use it:
```javascript
CREATEPNG(
OUTFILE, // Output file name (without extension)
_WIDTH, // Width of the image
_HEIGHT, // Height of the image
_BITDEPTH, // Bit depth (1*, 2*, 4, 8, or 16)
_COLORTYPE, // Color type (0, 2, 3**, 4, or 6)
__IGNORESIZELIM, // Optional: Ignore size limit check (true or false)
);
```
- `OUTFILE`: Specify the name of the output file without the extension. The script will automatically add the necessary details to the file name.
- `_WIDTH` and `_HEIGHT`: Set the dimensions of the image.
- `_BITDEPTH`: Choose the bit depth for the image (1*, 2\*, 4, 8, or 16).
- `_COLORTYPE`: Select the color type for the image (0, 2, 3**, 4, or 6).
- `__IGNORESIZELIM` (optional): Set to true to ignore size limit checks, this is __NOT__ recommended
*Bitdepth 1 & 2 are currently umsupported and unstable.\
**Colortype 3 does not currently have implementation, it does __not__ work.
## Additional Information
Check the provided links in the code for detailed information about PNG chunks and specifications.
Time statistics for coding and PNG generation are included in the code comments.
## Note
Ensure you have sufficient memory allocated to Node.js, especially if generating large PNG files.
- Adjust the maxHeapSize variable in the script if needed.
Modify the code as per your requirements, such as adding support for additional color types or customizing chunk data.
## Examples
Here are some examples of how to use the CREATEPNG function:
```javascript
CREATEPNG("MyImage", 1024, 1024, 8, 2); // Generates an 8-bit depth, truecolor PNG named "MyImage_W1024_H1024_B8_C2.png".
CREATEPNG("LargeImage", 2048, 2048, 16, 4, true); // Generates a 16-bit depth, grayscale with alpha PNG ignoring size limits.
```
Feel free to explore and modify the script to suit your PNG generation needs. Happy coding!
## License
This project is licensed under the [MIT License](LICENSE) - see the [LICENSE](LICENSE) file for details.