# @4bitlabs/codecs 

[![License][license]][npm]
[![NPM Version][version]][npm] 
[![NPM Downloads][dl]][npm]
[![Ko-fi][kofibadge]][kofi]

[npm]: https://www.npmjs.com/package/@4bitlabs/codecs
[version]: https://img.shields.io/npm/v/%404bitlabs%2Fcodecs
[license]: https://img.shields.io/npm/l/%404bitlabs%2Fcodecs
[dl]: https://img.shields.io/npm/dy/%404bitlabs%2Fcodecs
[kofibadge]: https://shields.io/badge/ko--fi-donate-ff5f5f?logo=ko-fi&style=for-the-badgeKo-fi
[kofi]: https://ko-fi.com/thirtytwo

A collection of decoders (and eventually encoders) for working with [Sierra On-line][sierra] [SCI-engine][sci0] assets.

## Documentation

Full documentation for the library can be found [here][docs].

[docs]: https://32bitkid.github.io/sci.js/modules/_4bitlabs_codecs.html

## Supported Codecs

| Name                    | Decoder | Encoder |
| ----------------------- | :-----: | :-----: |
| [Huffman][huffman]      |   ✅    |         |
| [Lempel–Ziv–Welch][lzw] |   ✅    |         |
| COMP3                   |   ✅    |         |

[sierra]: https://en.wikipedia.org/wiki/Sierra_Entertainment
[huffman]: https://en.wikipedia.org/wiki/Huffman_coding
[lzw]: https://en.wikipedia.org/wiki/Lempel%E2%80%93Ziv%E2%80%93Welch
[sci0]: http://sciwiki.sierrahelp.com/index.php/Sierra_Creative_Interpreter