Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/deepnight/ldtk
Modern, lightweight and efficient 2D level editor
https://github.com/deepnight/ldtk
2d electron game-development haxe haxe-libs level-editor
Last synced: 5 days ago
JSON representation
Modern, lightweight and efficient 2D level editor
- Host: GitHub
- URL: https://github.com/deepnight/ldtk
- Owner: deepnight
- License: mit
- Created: 2020-05-29T09:39:23.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-11-13T09:10:55.000Z (2 months ago)
- Last Synced: 2025-01-07T14:03:35.372Z (12 days ago)
- Topics: 2d, electron, game-development, haxe, haxe-libs, level-editor
- Language: Haxe
- Homepage: https://ldtk.io
- Size: 148 MB
- Stars: 3,481
- Watchers: 44
- Forks: 195
- Open Issues: 313
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-game-engine-dev - LDtk - Modern, lightweight and efficient 2D level editor. [[Website](https://ldtk.io)] (Libraries / Haxe)
- awesome - deepnight/ldtk - Modern, lightweight and efficient 2D level editor (Haxe)
README
**Level Designer Toolkit** (*LDtk*) is a **modern**, **efficient** and **open-source** 2D level editor with a strong focus on user-friendliness.
Links: [Official website](https://ldtk.io/) | [Haxe API (on GitHub)](https://github.com/deepnight/ldtk-haxe-api)
[](https://github.com/deepnight/ldtk)
[](https://github.com/deepnight/ldtk/releases/latest)
[](https://github.com/deepnight/ldtk/actions/workflows/test-windows.yml)
[](https://github.com/deepnight/ldtk-haxe-api/actions/workflows/unitTests.yml)
# Getting LDtk latest version
Visit [LDtk.io](https://ldtk.io) to get latest version.
# Building from source
## Requirements
- **[Haxe compiler](https://haxe.org)**: you need an up-to-date and working Haxe install to build LDtk.
- **[NPM](https://nodejs.org/en/download/)**: this package manager is used for various install and packaging scripts. It is packaged with NodeJS.
## Installing required stuff
- Open a command line **in the `ldtk` root dir**,
- Install required Haxe libs:
```
haxe setup.hxml
```
- Install Electron locally and other dependencies through NPM (**IMPORTANT**: you need to be in the `app` dir):
```
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**:
- 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
```
## Running
From a command line in the `app` folder, run:
```
npm run start
```
# Contributing
You can read the general Pull Request guidelines here:
https://github.com/deepnight/ldtk/wiki#pull-request-guidelines
# Related tools & licences
- Tileset images: see [README](app/extraFiles/samples/README.md) 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)