From 267f22b48408d83d221637e31c3da6a6dacd975d Mon Sep 17 00:00:00 2001 From: Louis Pearson Date: Wed, 3 Aug 2022 13:18:28 -0600 Subject: [PATCH] Add features to readme --- README.md | 33 +++++++++++++++++++++++++++++---- 1 file changed, 29 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index c8657d8..af67f7a 100644 --- a/README.md +++ b/README.md @@ -2,9 +2,9 @@ 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 const LDtk = @import("./LDtk.zig"); @@ -14,8 +14,33 @@ const ldtk = LDtk.parse(allocator, ldtk_file); defer ldtk.deinit(); // Now you can access your LDtk data through the `ldtk` struct -for (ldtk.levels) { +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