https://github.com/phoenixr-codes/nlzss

Nintendo's LZSS (de)compression
https://github.com/phoenixr-codes/nlzss

3ds compression lzss nintendo

Last synced: 4 months ago
JSON representation

Nintendo's LZSS (de)compression

• Host: GitHub
• URL: https://github.com/phoenixr-codes/nlzss
• Owner: phoenixr-codes
• License: mit
• Created: 2024-06-20T17:01:38.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2026-02-17T19:18:07.000Z (4 months ago)
• Last Synced: 2026-02-18T00:49:34.073Z (4 months ago)
• Topics: 3ds, compression, lzss, nintendo
• Language: Dart
• Homepage: https://pub.dev/packages/nlzss
• Size: 15.6 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# nlzss - (de)compression with Nintendo's [LZSS][] format

[![Pub Version](https://img.shields.io/pub/v/nlzss?style=for-the-badge)](https://pub.dev/packages/nlzss)

[![GitHub Repo stars](https://img.shields.io/github/stars/phoenixr-codes/nlzss?style=for-the-badge)](https://github.com/phoenixr-codes/nlzss)

[![Pub Likes](https://img.shields.io/pub/likes/nlzss?style=for-the-badge)](https://pub.dev/packages/nlzss)

## CLI Usage

### Compress

```bash

cat file | nlzss compress > file.bin

```

Instead of `compress` you can also use the `c` shorthand. To specify the

algorithm to use, add `--level 11` (default) or `--level 10`.

### Decompress

```bash

cat file.bin | nlzss decompress > file

```

Instead of `decompress` you can also use the `d` shorthand.

## References

- [nintendo-lz][] - The codebase was heavily inspired by this

- [nzlss][nzlss-python]

[LZSS]: https://en.wikipedia.org/wiki/Lempel%E2%80%93Ziv%E2%80%93Storer%E2%80%93Szymanski

[nintendo-lz]: https://gitlab.com/DarkKirb/nintendo-lz

[nzlss-python]: https://github.com/magical/nlzss