Support development of enkiMI through Github Sponsors or Patreon

enkiMI

enki Minecraft Importer

A permissively licensed lightweight C and C++ Minecraft Importer library.

Building

A cmake file is included for the example code, but to use in your project simply add the 2 .c the files in /src into your project and add the director to your include paths.

Using

enkiMI currently includes NBT file reading (compressed or uncompressed), and region/anvil file chunk extraction.

FILE *fp = fopen( "../example/r.1.0.mca", "rb" );
enkiRegionFile regionFile = enkiRegionFileLoad( fp );
for( int i = 0; i < ENKI_MI_REGION_CHUNKS_NUMBER; i++ )
{
    enkiNBTDataStream stream;
    enkiInitNBTDataStreamForChunk( regionFile,  i, &stream );
    if( stream.dataLength )
    {
        enkiChunkBlockData aChunk = enkiNBTReadChunk( &stream );
        enkiMICoordinate chunkOriginPos = enkiGetChunkOrigin( &aChunk ); // y always 0
        printf( "Chunk at xyz{ %d, %d, %d }  Number of sections: %d \n",
            chunkOriginPos.x, chunkOriginPos.y, chunkOriginPos.z, aChunk.countOfSections );
    }
    enkiNBTFreeAllocations( &stream );
}
enkiRegionFileFreeAllocations( &regionFile );
fclose( fp );

Credits

• Miniz from richgel999
• Example model r.1.0.mca Dinner Party by Vanillaburp - Youtube - Twitter @Vanillaburp
• Thanks to Voxtric for their C# Minecraft Level Ripper which got us started
• ephtracy for the Minecraft palette colours
• Thanks to WesterosCraft, MrBatou, and Greenfield City for letting us use their Minecraft constructions to test the importer with our game Avoyd
• Breno Machado for reporting a chunk loading issue and assisting with testing
• Nicolas Bissig for reporting an extended height (Minecraft v1.17+) chunk loading issue and assisting with testing

License (zlib)

Copyright (c) 2017 Juliette Foucaut and Doug Binks

This software is provided 'as-is', without any express or implied warranty. In no event will the authors be held liable for any damages arising from the use of this software.

Permission is granted to anyone to use this software for any purpose, including commercial applications, and to alter it and redistribute it freely, subject to the following restrictions:

1. The origin of this software must not be misrepresented; you must not claim that you wrote the original software. If you use this software in a product, an acknowledgement in the product documentation would be appreciated but is not required.
2. Altered source versions must be plainly marked as such, and must not be misrepresented as being the original software.
3. This notice may not be removed or altered from any source distribution.