Skip to content

Commit edfd5ea

Browse files
authored
Update README.md
1 parent 9d6239c commit edfd5ea

File tree

1 file changed

+28
-1
lines changed

1 file changed

+28
-1
lines changed

README.md

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,29 @@
11
# LDtkParser
2-
A parser for .ldtk levels for GameMaker: Studio 2.3
2+
## A feature-rich parser for .ldtk levels for GameMaker: Studio 2.3
3+
4+
### Maintaned by [@evolutionleo](https://github.com/evolutionleo/) (me)
5+
6+
## Features
7+
- Load LDtk levels with all their contents with one function call!
8+
- Powerful mapping configuration to map layers/entities/fields/enums names in LDtk to their equivallents in GMS (in case they don't match)
9+
- Entities fields and Enums support!
10+
- **Live Updating!** Reload levels in real time!
11+
12+
## Installing
13+
### 1) Go to [Releases](https://github.com/evolutionleo/LDtkParser/releases/latest) and download the latest .yymps
14+
### 2) Import it to your project via Tools/Import Local Package
15+
### 3) PROFIT!
16+
17+
## Setting Up
18+
- Put an instance of `oLDtk` somewhere
19+
- `LDtkConfig()` (oLDtk has the basic configuration, you can modify it)
20+
- (Optional) if any of your objects use Variable Definitions, you'll need to enable the `escape_fields` config and call `LDtkReloadFields()` in their Create Event
21+
22+
## Live Updating
23+
- Disable file system sandbox in the settings
24+
- Enable the macro `LDTK_LIVE`
25+
- Change the live config's file path so that it loads the .ldtk file from your project's folder
26+
27+
28+
## Contributing
29+
Open an issue or make a pull request

0 commit comments

Comments
 (0)