README.md

The Nexus (.nx) Archive Format

A Quite OK Archive Format.
For Storing and Sharing Mods.

About

The Nexus (.nx) format is a semi-SOLID archive format, using modern compression technologies such as ZStandard and LZ4 under the hood.

flowchart TD
    subgraph Block 2
        BigFile1.bin
    end

    subgraph Block 1
        BigFile0.bin
    end

    subgraph Block 0
        ModConfig.json -.-> Updates.json 
        Updates.json -.-> more["... more .json files"]        
    end

Loading

Between size optimized SOLID archives like .7z w/ LZMA and non-SOLID archives like .zip w/ Deflate, the Nexus (.nx) format bridges the gap; providing a tradeoff with most of the benefit of both worlds.

We aim to create a simple format, appropriate for both local storage of mods and for downloading from the web.
By using modern compression techniques, we provide both competitive file size and compression speeds.

To learn more, have a look at the dedicated documentation page 🧡.