StreetLight
/
zig-ldtk
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add features to readme

dev
Louis Pearson 2022-08-03 13:18:28 -06:00
parent 511bdab4ed
commit 267f22b484
1 changed files with 29 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
README.md
View File

@ -2,9 +2,9 @@
This is a single file library for parsing LDtk JSON files. This is a single file library for parsing LDtk JSON files.
## Using ## Usage
Copy `LDtk.zig` into your project and use like so: Copy `LDtk.zig` into your project, or add this repository as a git submodule.
```zig ```zig
const LDtk = @import("./LDtk.zig"); const LDtk = @import("./LDtk.zig");
@ -18,4 +18,29 @@ for (ldtk.levels) {
// ... // ...
} }
``` ```
Alternatively, add this repository as a git submodule.
## Features
- [x] Parse unseperated LDtk file
- [ ] Parse seperated LDtk files
- [ ] Load unseperated LDtk
- [ ] Load seperated LDtk
- [ ] Supported JSON Schema
- [x] 1. LDtk Json root
- [x] 1.1. World Generic
- [x] 2. Level
- [x] 2.1. Layer instance
- [x] 2.2. Tile instance Generic
- [x] 2.3. Entity instance
- [ ] 2.4. Field instance
- [ ] 2.4.2. Field instance entity reference Generic
- [ ] 2.4.3. Field instance grid point Generic
- [ ] 3. Definitions
- [ ] 3.1. Layer definition
- [ ] 3.1.1. Auto-layer rule definition
- [ ] 3.2. Entity definition
- [ ] 3.2.1. Field definition Generic
- [ ] 3.2.2. Tileset rectangle Generic
- [ ] 3.3. Tileset definition
- [ ] 3.4. Enum definition
- [ ] 3.4.1. Enum value definition