Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/dougbinks/enkiMI

C and C++ Minecraft Importer library
https://github.com/dougbinks/enkiMI

minecraft minecraft-constructions minecraft-java-edition nbt-library voxel voxel-data voxel-terrain voxels

Last synced: 3 months ago
JSON representation

C and C++ Minecraft Importer library

Host: GitHub
URL: https://github.com/dougbinks/enkiMI
Owner: dougbinks
License: zlib
Created: 2017-04-20T16:01:47.000Z (about 7 years ago)
Default Branch: master
Last Pushed: 2023-10-09T10:48:37.000Z (9 months ago)
Last Synced: 2024-01-20T19:31:52.207Z (6 months ago)
Topics: minecraft, minecraft-constructions, minecraft-java-edition, nbt-library, voxel, voxel-data, voxel-terrain, voxels
Language: C
Homepage:
Size: 199 KB
Stars: 87
Watchers: 11
Forks: 12
Open Issues: 1
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: License.txt

Lists

AwesomeCppGameDev - enkiMI
awesome-voxel - EnkiMI

README

        Support development of enkiMI through [Github Sponsors](https://github.com/sponsors/dougbinks) or [Patreon](https://www.patreon.com/enkisoftware)

[](https://github.com/sponsors/dougbinks)    [](https://www.patreon.com/enkisoftware)

![enkiMI Logo](https://github.com/dougbinks/images/blob/master/enkiMI_logo_no_padding.png?raw=true)

# 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](https://github.com/dougbinks/enkiMI/tree/master/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](https://github.com/richgel999/miniz)  

* Example model [r.1.0.mca Dinner Party](http://www.planetminecraft.com/project/minecraft-custom-modeling-dinner-party/) by Vanillaburp - [Youtube](https://www.youtube.com/user/vanillaburp) - [Twitter @Vanillaburp](https://www.twitter.com/Vanillaburp)  

* Thanks to Voxtric for their [C# Minecraft Level Ripper](https://github.com/Voxtric/Minecraft-Level-Ripper) which got us started  

* [ephtracy for the Minecraft palette colours](http://ephtracy.github.io/)  

* Thanks to [WesterosCraft](http://www.westeroscraft.com/guide), [MrBatou](https://www.planetminecraft.com/project/cuirass-dsd-401-by-mrbatou-download-cinematic/), and [Greenfield City](http://www.greenfieldmc.net) for letting us use their Minecraft constructions to test the importer with our game [Avoyd](https://www.avoyd.com)  

* Breno Machado for reporting a chunk loading issue and assisting with testing

* [Nicolas Bissig](https://github.com/NicolasBissig) for reporting an extended height (Minecraft v1.17+) chunk loading issue and assisting with testing

[![Two Minecraft constructions imported into Avoyd: Greenfield City and MrBatou Cuirassé DSD-401 with link to Youtube showcase video](https://raw.githubusercontent.com/dougbinks/images/master/Avoyd_2021-01-18_YoutubeThumbnailForGithub.jpg)](https://www.youtube.com/watch?v=n8oiVRhzwxE)

## 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.