When I set out to create AM2E, I settled on LDtk as my level editor of choice due to the wealth of features and straightforward user interface. I knew that I would have to add some features, but I hoped they would be generic enough that they could be merged into the main project.
Unfortunately, my PRs have mostly been ignored. While I do not enjoy fragmenting open-source software and would much rather just contribute upstream, it's clear that my design goals do not align with deepnight's. As such, I have decided to maintain this fork for use with my game engine, AM2E.
If at any point these design goals realign, I would be glad to see my added features introduced upstream and focus on PRs to the main project instead of maintaining this fork.
Level Designer Toolkit (LDtk) is a modern, efficient and open-source 2D level editor with a strong focus on user-friendliness.
Links: Official website | Haxe API (on GitHub)
Visit LDtk.io to get latest version.
- Haxe compiler: you need an up-to-date and working Haxe install to build LDtk.
- NPM: this package manager is used for various install and packaging scripts. It is packaged with NodeJS.
- Open a command line in the
ldtkroot dir, - Install required Haxe libs:
haxe setup.hxml
- Install Electron locally and other dependencies through NPM (IMPORTANT: you need to be in the
appdir):
cd app
npm i
First, from the root of the repo, build the electron Main:
haxe main.debug.hxml
This should create a app/assets/main.js file.
Then, build the electron Renderer:
haxe renderer.debug.hxml
This should create app/assets/js/renderer.js.
If you want to try a future version of LDtk, you can checkout branches named dev-x.y.z where x.y.z is version number.
IMPORTANT:
- these dev branches might be unstables, or even broken. Therefore, it's not recommended to use, unless you plan to add or fix something on LDtk.
- because dev branches might change quickly, you will need to update haxelibs often.
- you will need to switch the LDtk haxe API to the same branch as LDtk repo. (adapt the branch name below accordingly):
haxelib git ldtk-haxe-api https://github.com/deepnight/ldtk-haxe-api.git dev-0.6.0
From a command line in the app folder, run:
npm run start
You can read the general Pull Request guidelines here: https://github.com/deepnight/ldtk/wiki#pull-request-guidelines
- Tileset images: see README in samples
- Haxe: https://haxe.org/
- Heaps.io: https://heaps.io/
- Electron: https://www.electronjs.org/
- JQuery: https://jquery.com
- MarkedJS: https://github.com/markedjs/marked
- SVG icons from https://material.io
- Default palette: "Endesga32" by Endesga (https://lospec.com/palette-list/endesga-32)
- Default color blind palette: "Colorblind 16" by FilipWorks (https://github.com/filipworksdev/colorblind-palette-16)