ncomp

ncomp - CUE's Nintendo compressors as library

This fork bundles CUE's compressors into one library.

• BLZ
• Huffman
• LZE
• LZSS
• LZX
• RLE

Usage

Before using it, please make sure your project is GPL-3.0 compatible, as this license was inherited from the original work.

Build

Generate the library in build and copy ncomp.h to include:

git clone https://github.com/Gonhex/ncomp.git
cd ncomp
mkdir build && cd build
cmake ..
cmake --build .

To build in release mode, use cmake .. -DCMAKE_BUILD_TYPE=Release.

Or as submodule in a CMake project:

add_subdirectory(ncomp)
...
target_link_libraries(${PROJECT_NAME} ncomp)

Example C

#include <ncomp.h> // in c++, surround this with extern "C" {}
...
ncomp_buffer arm9 = ncomp_BLZ_Decode(comp_arm9_ptr, comp_arm9_length);
if (arm9.error == ncomp_error_none)
{
    // do something with arm9.data and arm9.length;

    ncomp_Free(&arm9); // free memory when arm9 is no longer needed
}
else
{
    printf("%s\n", ncomp_error_message[arm9.error]);
}

Example Go

import "github.com/Gonhex/ncomp"
...
arm9, err := ncomp.BlzDecode(comp_arm9)
if err != nil {
	log.Println(err)
} else {
	// do something with arm9
}