LDtk Loader •

Load LDtk levels in your C++ game

LDtkLoader is a loader for LDtk tile maps.

You can use it to load LDtk levels in your game and access any data you need via the API.

Sample code

A taste of simplicity :

// load the file
ldtk::World world;
world.loadFromFile("my_levels.ldtk");

// get a level
const auto& level1 = world.getLevel("Level1");

// get a layer
const auto& bg_layer = level1.getLayer("BgLayer");

// iterate on the tiles of the layer
for (const auto& tile : bg_layer.allTiles()) {
    // do something with the tile (storing, rendering ...)
}

// iterate on Enemy entities
for (const auto& enemy : level1.getLayer("Entities").getEntities("Enemy")) {
    
    // iterate over an array field of Enum values
    for (const auto& item : enemy.getArrayField<ldtk::EnumValue>("items")) {
        // test if field is null
        if (!item.is_null()) {
            // do something with item
            if (item == world.getEnum("Items")["Sword"]) {
                // the enemy has a Sword !
            }
        }
    }

    // get an Entity field
    int enemy_hp = enemy.getField<int>("HP").value();
}

Build

Should work with any C++11 compiler. (MSVC uses --config to specify build type, other compilers use the CMAKE_BUILD_TYPE variable)

mkdir build && cd build
cmake [-DCMAKE_BUILD_TYPE={Debug|Release}] ..
cmake --build . [--config {Debug|Release}]

Additional CMake options you can pass :

-DLDTK_NO_THROW : to print message and exit when there is an error instead of throwing exceptions
-DBUILD_API_TEST : to build the API test example, to make sure the library works as expected
-DBUILD_SFML_EXAMPLE=ON : to build the SFML example (requires SFML installed)
- set -DSFML_ROOT=/path/to/SFML/ if CMake is unable to find it
- set -DSFML_STATIC_LIBRARIES=TRUE if you want to link the static libraries
-DBUILD_SDL_EXAMPLE=ON : to build the SDL example (requires SDL2 and SDL2_image installed)

Install

In the build directory, run :

cmake [-DCMAKE_INSTALL_PREFIX=/install/path/LDtkLoader] ..
cmake --install . [--config {Debug|Release}]

This will copy the libraries, the headers and the cmake config files to the install path.

How to use LDtkLoader in your project

After installation, to use the LDtkLoader library in your CMake project, you can just call :

find_package(LDtkLoader)

The find_package command will automatically get the correct library (release or debug) depending on your current CMake configuration.

Then you only have to link the library to your target :

target_link_libraries(YourTarget PRIVATE LDtkLoader)

Note : if you installed LDtkLoader at a custom path, you might need to pass a -DLDtkLoader_ROOT=/install/path/LDtkLoader option to cmake so it can find the package.

Documentation

Documentation is under construction and can be found on the wiki.

Alternatively, you can build the API documentation with doxygen using the provided Doxyfile.

To Do

Helper classes/methods for SFML or SDL rendering
API documentation

License

LDtkLoader is licensed under the zlib license.

Bundled dependencies :

json - MIT license
Optional - Boost Software Licence

ItsAnas / LDtkLoader