ldtk README

The project's README from github.com/deepnight/ldtk. As one markdown file: README.md.

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)

GitHub Repo stars GitHub All Releases GitHub Workflow Status GitHub Workflow Status

Getting LDtk latest version

Visit LDtk.io to get latest version.

Building from source

Requirements

Installing required stuff

haxe setup.hxml
cd app
npm i

Compiling master branch

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.

Compiling another branch

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:

haxelib git ldtk-haxe-api https://github.com/deepnight/ldtk-haxe-api.git dev-0.6.0

Running

From a command line in the app folder, run:

npm run start

Running inside Hide (as an editor plugin)

LDtk can run embedded in a Hide tab.

First build the plugin (from the ldtk root dir):

haxe hide-plugin.hxml

This creates app/nwjs/hide-plugin.js (sources in src/hide/plugin/). Then add to the Hide project's res/props.json (ldtk.project is optional and resolves relative to res/):

"plugins": [ "/path/to/ldtk/app/nwjs/hide-plugin.js" ],
"menu.extra": "<menu label='LDtk' component='ldtk.LdtkView'></menu>",
"ldtk.project": "path/to/world.ldtk"

LDtk then opens from the menu, in its own tab. Bonus: its CastleDB enum sync reads Hide's live database, unsaved changes included.

Running in NW.js (instead of Electron)

The renderer can also run standalone in NW.js, without the Electron main process:

nw app/nwjs

Contributing

You can read the general Pull Request guidelines here: https://github.com/deepnight/ldtk/wiki#pull-request-guidelines

Related tools & licences

ldtk (deepnight/ldtk)

Searching Database…

5K ·GitHub
What is this?LDtk (Level Designer Toolkit) is a modern, lightweight and efficient open-source 2D level editor for designing game levels.
Is it a game engine or just a level editor?It is a level editor, not a game engine. The app is a standalone 2D editor built on Electron, with Haxe used for its code.
How do I get it running?Download the latest version from LDtk.io. To build from source, run it from the app folder after installing the Haxe libs and Electron through NPM.
Do I need Haxe and Node.js to use it?Not for the prebuilt app. Building from source needs an up-to-date Haxe install and NPM, which comes bundled with NodeJS.
Is it safe to try the dev branches?Not for everyday work. The dev-x.y.z branches may be unstable or broken and change quickly, so you will need to update the Haxe libs often.
Which operating systems does it run on?The README does not name specific operating systems. It is an Electron desktop app, so it targets desktop systems.
Can I run LDtk inside the Hide editor?Yes. Build the Hide plugin, then add LDtk to Hide's res/props.json. It opens in its own tab and its CastleDB enum sync reads Hide's live database, including unsaved changes.
Can it run without Electron?Yes. The renderer can also run standalone in NW.js, without the Electron main process.
Is there a Haxe API for LDtk?Yes, a Haxe API is hosted separately on GitHub. When you build a dev branch, switch the API to the same branch as the LDtk repo.
What are similar projects?tiled, opentoonz, MonoGame, shift, CanvasTTY, DSH-Launcher, PicGo, hydra
Creator
deepnight
Size
150.5 MB
Stars
5K
Age
6y
Commits · 90 Days