A simple LDtk loader for LÖVE.

It was tested with LDtk v0.9.3

All layer types are supported.

Place ldtk.lua anywhere in the project and make sure you have json.lua in the same folder.

add this to the top of main.lua

local ldtk = require 'path/to/ldtk.lua'

json.lua is needed because LDtk relies on json.

You can add your tilesets anywhere relative to main.lua.

I recommend checking "Minify JSON", "Save levels to separate files" and "Advanced --> discard pre-CSV..." in project settings to save space and increase loading speed.

Load the .ldtk file using

ldtk:load('path/to/file.ldtk')

check main.lua for a detailed example on how to use this library.

callbacks gives you the extracted data from LDtk project file.

entity

layer

levelData

loads the .ldtk project file.

ldtk:load('path/to/file.ldtk')

returns nothing

loads a level by its index starting at 1 as the first level

ldtk:goTo(3) --loads the third level

returns nothing

loads a level by its id (name)

ldtk:load('menu') --loads the level named menu

returns nothing

loads the next level or the first if we are in the last

ldtk:next() --loads the next level

returns nothing

loads the next level or the last if we are in the first

ldtk:previous() --loads the previous level

returns nothing

reloads current level

ldtk:reload() --reloads current level

returns nothing

gets current level index. can be accesed as ldtk.current

ldtk:getCurrent() --gets current level index

returns integer

gets current level name.

ldtk:getCurrentName() --gets current level name

returns string

gets a level index by its name

ldtk.getIndex('menu') --gets the index of the level named menu

returns integer

gets a level name by its index

ldtk.getName(3) --gets the name of the third level

returns string

removes the cached images and quads. you may use it before loading another .ldtk file

ldtk.removeCache() --remove the cached images and quads

returns nothing

gets an RGB color (on a scale of 0 to 1) from a HEX color

ldtk.getColorHex('#316f1b') --gets the rgb color of #316f1b

returns table (r, g, b) like (0.2, 1, 0.49)

makes the path relative to main.lua instead of the .ldtk file

ldtk.getPath('../tilesets/tiles.png') --gets the the relative path to main.lua

returns string

whether to flip the order or not. false by default and can be accessed like ldtk.flipped

ldtk.setFlipped(true) -- flips the order and the top layer will be created last

returns nothing

gets whether the order is flipped or not. same as ldtk.flipped

ldtk.getFlipped() -- is the order flipped ?

returns boolean

If you like what you see, you can help by sharing. Pull requests are welcome.

You can became a Patreon if you want :3

MIT

Have Fun!