Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/NicMagnier/PlaydateLDtkImporter
Load tilemaps created with LDtk in your playdate games
https://github.com/NicMagnier/PlaydateLDtkImporter
Last synced: about 2 months ago
JSON representation
Load tilemaps created with LDtk in your playdate games
- Host: GitHub
- URL: https://github.com/NicMagnier/PlaydateLDtkImporter
- Owner: NicMagnier
- License: mit
- Created: 2022-05-22T15:40:17.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-29T11:02:28.000Z (6 months ago)
- Last Synced: 2024-04-16T13:56:14.540Z (5 months ago)
- Language: Lua
- Size: 186 KB
- Stars: 84
- Watchers: 6
- Forks: 11
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
- awesome-playdate - PlaydateLDtkImporter - Load tilemaps created with LDtk in playdate games (Game Development / Development & Graphics tools)
README
# PlaydateLDtkImporter
[](https://lua.org) [](https://toyboxpy.io) [](https://github.com/NicMagnier/PlaydateLDtkImporter/tags)
Load tilemaps created with LDtk in playdate games
## How to use LDtk levels on Playdate
#### Using toybox.py
You can add it to your **Playdate** project by installing [**toybox.py**](https://toyboxpy.io), going to your project folder in a Terminal window and typing:
```console
toybox add LDtkImporter
toybox update
```
Then, if your code is in the `source` folder, just import the following:
```lua
import '../toyboxes/toyboxes.lua'
```
#### Manually
You first need to copy the file `Ldtk.lua` in your playdate project and to import it
```lua
import 'LDtk'
```
Next you need to load your main .ldtk file, typically during the game loading
```lua
LDtk.load( "MyWorld.ldtk" )
```
If your LDtk world is saved in multiple files (in this case you see a .ldtkl file for each level in your structure) you need to manually load the levels.
```lua
LDtk.load_level( "TheFirstLevel" )
```
And you can also release the level and the assets used by it.
```lua
LDtk.release_level( "TheFirstLevel" )
```
It is usually better to load a new level before releasing the previous one because if they share the same asset, these assets will not need to be loaded.
### Using a level
#### Tilemap
When you want to finally use a level in your game, you need to create the playdate tilemap object
```lua
LDtk.create_tilemap( "TheFirstLevel" )
```
#### Collisions
You can also query the tiles using enum values you have setup in your Ldtk world using `LDtk.get_tileIDs()` but to generate collision the Playdate SDK requires tiles that are should by empty so `LDtk.get_empty_tileIDs() should be used instead.
```lua
local tilemap = LDtk.create_tilemap( "TheFirstLevel", "gameplay_layer" )
playdate.graphics.sprite.addWallSprites( tilemap, LDtk.get_empty_tileIDs( "TheFirstLevel", "Solid", "gameplay_layer") )
```
#### Entities
`LDtk.get_entities()` will give you all the entities setup in a level including all their custom fields.
```lua
for index, entity in ipairs( LDtk.get_entities( "TheFirstLevel" ) ) do
if entity.name=="Player" then
player.sprite:add()
player.init( entity )
end
end
```
### Changelog
#### version 1.07
- Fix bug introduced in 1.06 where tileset would not load + code cleanup (Thank SquidGoDev)
#### version 1.06
- add property world_positon to entities (LDtk version 1.5.0)
- add new neighbours option (back, front, northwest, northeast, southwest, southeast) (Thx jojomo96)
#### version 1.05
- Improve error reporting
- Added MIT License to the project
- Add new function to get the level name from IID (Thx GammaGames)
- Fix path bug when exporting level (Thx zukas3)
- Fix loading of custom data (Thx GammaGames)
#### version 1.04
- Fix issue with fast loading that was not using the correct path
- Add error message when the level lua file is not found when using fast loading
#### version 1.03
- Fix crash when the LDtk internal icons are used in a level
#### version 1.02
- Make it possible to have the ldtk file at the root of the project
#### version 1.01
- Make it possible to use tileset that are in any folder of the project, not just under the ldtk file
- Added function to generate image from a tileset rect