# @pretendonetwork/pictobox

> TypeScript library for interacting with several different image types, including those exclusive to the Wii U and 3DS

Latest version **1.0.4** (published 2024-02-19) · APGL license · 0 weekly downloads

## Install

```sh
npm install @pretendonetwork/pictobox
pnpm add @pretendonetwork/pictobox
yarn add @pretendonetwork/pictobox
bun add @pretendonetwork/pictobox
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.4 |
| Published | 2024-02-19 |
| First published | 2024-02-07 |
| Weekly downloads | 0 |
| License | APGL |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 160 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | jonbarrow |
| Keywords | image, picture, png, bmp, tga, rgb, rgba, rgb565, rgb565a4, etc1, etc1a4 |

## Links

- npm: https://www.npmjs.com/package/@pretendonetwork/pictobox
- npm.io page: https://npm.io/package/@pretendonetwork/pictobox

## Dependencies (2)

- [pako](https://npm.io/package/pako.md) ^2.1.0
- [buffer-crc32](https://npm.io/package/buffer-crc32.md) ^1.0.0

## Alternatives

- [exif-parser](https://npm.io/package/exif-parser.md) — 3.8M weekly downloads
- [vite-plugin-compression](https://npm.io/package/vite-plugin-compression.md) — 569.5K weekly downloads
- [pica](https://npm.io/package/pica.md) — 442.4K weekly downloads
- [@reportportal/client-javascript](https://npm.io/package/@reportportal/client-javascript.md) — 408.8K weekly downloads
- [@tldraw/state](https://npm.io/package/@tldraw/state.md) — 316.0K weekly downloads

## Recent versions

- 1.0.4 (latest) — 2024-02-19
- 1.0.3 — 2024-02-19
- 1.0.2 — 2024-02-17
- 1.0.1 — 2024-02-17
- 1.0.0 — 2024-02-07

## README

# Picto Box
TypeScript library for interacting with several different image types, including those exclusive to the Wii U and 3DS

## Why?
While there are several libraries already available for NodeJS for various image types, most of these have at least one of the following issues:

- Outdated/unmaintained
- Does not completely/accurately follow image specification
- Inconsistent API with other libraries
- API is cumbersome to work with in our systems
- Library is poorly documented or structured, leading to development and/or performance issues
- A library does not exist for the image type

Because of this, we have decided to create our own library with the following goals:

- Consistent API, making image conversions simple and nice to do
- Support a wide range of image types, including those specific to Nintendo consoles
- Follow image specifications as completely and accurately as possible
  - Some images are Nintendo variants of standard formats. In these cases the image specification may not be entirely followed (though compatibility with non-Nintendo images is always a goal)
- Well structured classes with clear field/method names. These names should come from, or be derived by, the images specification
- Good documentation. Including self-documented code, TSDoc comments, regular comments, and linking to reference material to assist with bug fixes/specification inaccuracies

## Installation
```
npm i @pretendonetwork/pictobox
```

## Supported files
- [x] BMP
- [x] TGA
- [x] PNG
- [ ] ETC1A4. Nintendo variant of [ETC1](https://registry.khronos.org/DataFormat/specs/1.1/dataformat.1.1.html#ETC1) with added alpha data. (Can decode but not encode)
- [ ] [Indexed images](https://github.com/PretendoNetwork/indexed-image-converter)
- [x] RGB565A4. Nintendo variant of [RGB565](https://en.wikipedia.org/wiki/List_of_monochrome_and_RGB_color_formats#16-bit_RGB_.28also_known_as_RGB565.29) with added alpha data

## Example
```ts
// Convert an RGB565 (with alpha) image to a PNG

import fs from 'node:fs';
import RGB565A4 from '@pretendonetwork/pictobox/rgb565a4';
import PNG from '@pretendonetwork/pictobox/png';

const rgb565Data = fs.readFileSync('./badge.rgb565');
const rgb565Alpha = fs.readFileSync('./badge.a4');

const rgb565 = new RGB565A4();

rgb565.width = 64;
rgb565.height = 64;
rgb565.parseFromBuffer(rgb565Data, rgb565Alpha);

const png = new PNG();

png.width = rgb565.width;
png.height = rgb565.height;
png.pixels = rgb565.pixels;
png.bitDepth = PNG.BitDepths.Bits8;
png.colorType = PNG.ColorTypes.RGBA;
png.interlaceMethod = PNG.InterlaceMethods.None;

const pngEncoded = png.encode();

fs.writeFileSync('./badge.png', pngEncoded);
```

---
_Source: https://npm.io/package/@pretendonetwork/pictobox · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._