ldtk-haxe-api
所属分类：collect
开发工具：Haxe
文件大小：0KB
下载次数：0
上传日期：2023-06-27 08:23:00
上 传 者：
sh-1993
说明： LDtk级别编辑器Haxe API（在HaxeLib上提供），
(LDtk level editor Haxe API (available on HaxeLib),)
文件列表:
.vscode/ (0, 2023-09-25)
.vscode/commandbar.json (1013, 2023-09-25)
.vscode/launch.json (380, 2023-09-25)
.vscode/settings.json (129, 2023-09-25)
.vscode/tasks.json (726, 2023-09-25)
LICENSE (1093, 2023-09-25)
haxelib.json (499, 2023-09-25)
samples/ (0, 2023-09-25)
samples/Flixel - Render tile layer/ (0, 2023-09-25)
samples/Flixel - Render tile layer/.vscode/ (0, 2023-09-25)
samples/Flixel - Render tile layer/.vscode/launch.json (300, 2023-09-25)
samples/Flixel - Render tile layer/.vscode/tasks.json (312, 2023-09-25)
samples/Flixel - Render tile layer/Project.xml (1687, 2023-09-25)
samples/Flixel - Render tile layer/src/ (0, 2023-09-25)
samples/Flixel - Render tile layer/src/Main.hx (180, 2023-09-25)
samples/Flixel - Render tile layer/src/PlayState.hx (899, 2023-09-25)
samples/Generic - Read project/ (0, 2023-09-25)
samples/Generic - Read project/ReadProject.hx (1613, 2023-09-25)
samples/Generic - Read project/build.hxml (364, 2023-09-25)
samples/Generic - Read project/index.html (1397, 2023-09-25)
samples/Heaps - Object tiles/ (0, 2023-09-25)
samples/Heaps - Object tiles/Heaps_ObjectTiles.hx (1489, 2023-09-25)
samples/Heaps - Object tiles/build.hxml (388, 2023-09-25)
samples/Heaps - Object tiles/index.html (1403, 2023-09-25)
samples/Heaps - Render IntGrid layer/ (0, 2023-09-25)
samples/Heaps - Render IntGrid layer/Heaps_IntGrid.hx (1120, 2023-09-25)
samples/Heaps - Render IntGrid layer/build.hxml (372, 2023-09-25)
samples/Heaps - Render IntGrid layer/index.html (1399, 2023-09-25)
samples/Heaps - Render full world/ (0, 2023-09-25)
samples/Heaps - Render full world/Heaps_FullWorld.hx (1166, 2023-09-25)
samples/Heaps - Render full world/build.hxml (380, 2023-09-25)
samples/Heaps - Render full world/index.html (1401, 2023-09-25)
samples/Heaps - Render tile layers/ (0, 2023-09-25)
samples/Heaps - Render tile layers/Heaps_TileLayers.hx (965, 2023-09-25)
... ...
# About
## What is this?
This is the Haxe API to load **LDtk Project JSON** files.
*LDtk is a modern and open-source 2D level editor.*
[Issue tracker (shared)](https://github.com/deepnight/ldtk/issues) |
[API documentation](https://ldtk.io/docs/game-dev/haxe-in-game-api/) |
[LDtk official page](https://ldtk.io)
[](https://github.com/deepnight/ldtk-haxe-api/actions/workflows/unitTests.yml)
## Features
- Compatible with all Haxe based frameworks and engines.
- Dedicated API for the following frameworks:
- Heaps.io
- [HaxeFlixel](https://haxeflixel.com/)
- **Completely typed at compilation**: if you rename any element in your project (ie. level, layer, entity, etc.), the corresponding references in your code will break accordingly, avoiding typical errors or mistypings.
- **Full completion in VScode**: if you have vs-haxe installed, you will get full completion while exploring your project file, based on its actual content, right from VScode.
# Usage
## Install
```
haxelib install ldtk-haxe-api
```
## Documentation
Please check the **full documentation and tutorials** here:
https://deepnight.net/docs/ldtk/haxe-api/
## Samples
You can check some examples in [samples](samples) folder.
Samples are built to **WebGL** (Javascript) and **Hashlink** targets, but you can try them on other compatible platforms too.
### Requirements
You need a standard **Haxe** install, and the following libraries installed: *heaps* (from source), *deepnightLibs* (from source), *hlsdl*:
```
haxelib git heaps https://github.com/HeapsIO/heaps.git
haxelib git deepnightLibs https://github.com/deepnight/deepnightLibs.git
haxelib install hlsdl
```
### Building samples
Open a folder in the `samples` folder (eg. `samples\Generic - Generic - Read project`) and run:
```
haxe build.hxml
```
You can also build all samples in one go. Go in `samples` folder and run:
```
haxe buildAll.hxml
```
### Rebuild samples HXMLs
If you modify the API, you might need to rebuild samples `HXML`s files themselves. In the root of the repo, run:
```
haxe genSamples.hxml
```
## Unit tests
You can build and run unit tests manually using the following commands **from the repository root**.
### JS/WebGL target
You will need Node interpreter to run the tests.
```
haxe tests\js.hxml
```
### Neko target
You will need Neko VM interpreter to run the tests.
```
haxe tests\neko.hxml
```
近期下载者：
相关文件：
收藏者：