Skip to content

emmercm/maxcso-js

Repository files navigation

💿️ maxcso

Pre-compiled binaries and Node.js wrapper for unknownbrackets' maxcso tool.

npm: version npm: downloads GitHub: stars license

Supported platforms

OS Architectures Additional Instructions
Windows
  • x64
  • x86
macOS
  • arm64 (Apple Silicon)
  • x64 (Intel)
lz4, libuv, and libdeflate are required to be installed separately:
brew install lz4 libuv libdeflate
Linux
  • x64
  • x86
  • arm64 v8

Running

You can easily run the maxcso binary for your OS from the command line like this:

npx maxcso [options..]

Examples:

npx maxcso --crc Disc.cso
npx maxcso --decompress Disc.cso -o Disc.iso
npx maxcso --format=cso1 Disc.iso -o Disc.cso

Installation

npm install --save maxcso

Usage

import maxcso from 'maxcso';

/**
 * Compress an ISO.
 */
await maxcso.compress({
  inputFilename: 'Disc.iso',
  outputFilename: 'Disc.cso',
});

/**
 * Given a compressed file, get the decompressed file's CRC32.
 */
const crc32 = await maxcso.uncompressedCrc32('Disc.cso');
console.log(crc32);
// "abcd01234"

/**
 * Decompress a CSO.
 */
await maxcso.decompress({
  inputFilename: 'Disc.cso',
  outputFilename: 'Disc.iso',
});

License

unknownbrackets' maxcso tool is licensed under the ISC license.