https://github.com/joafalves/java-ldtk-api

Java LDTK API utility library for loading LDTK json files into data classes.
https://github.com/joafalves/java-ldtk-api

game-development gamedev java ldtk ldtk-api

Last synced: 10 days ago
JSON representation

Java LDTK API utility library for loading LDTK json files into data classes.

• Host: GitHub
• URL: https://github.com/joafalves/java-ldtk-api
• Owner: joafalves
• License: apache-2.0
• Created: 2021-12-15T21:40:21.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2022-04-02T18:20:38.000Z (over 2 years ago)
• Last Synced: 2023-08-06T16:56:27.684Z (over 1 year ago)
• Topics: game-development, gamedev, java, ldtk, ldtk-api
• Language: Java
• Homepage:
• Size: 171 KB
• Stars: 1
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Java LDTK API data library

![](https://img.shields.io/badge/java-%3E%3D%208-green)

### What is this repository for? ###

This repository contains a full data model based on the latest API schema of [LDTK](https://ldtk.io/) (schema-extracted

using [QuickType](https://quicktype.io/)). In addition, also provides a set of converters to load the data model from a valid JSON source file.

### Examples ###

Load the data model from a valid LDTK json file:

`var projectData = LdtkConverter.fromJsonString(loadResourceFile("./data.json"));`

### Importing ###

The library is available as a Maven dependency on

repo [s01.oss.sonatype.org](https://s01.oss.sonatype.org/content/repositories/releases/) with the following coordinates:

`io.github.joafalves:java-ldtk-api`

Notice that the version matches the JSON version of the data model (minimum version is '0.9.3').

**Repository:**

`https://s01.oss.sonatype.org/content/repositories/releases/`

**Gradle Import:**

```

repositories {

    maven { url 'https://s01.oss.sonatype.org/content/repositories/releases/' }

}

dependencies {

    implementation 'io.github.joafalves:java-ldtk-api:latest.release'

}

```

**Maven Import:**

```

    io.github.joafalves

    java-ldtk-api

```

### Project Structure ###

This project is structured as follows:

##### Root Directory Structure #####

    .src/

        ├── main                    # Main classes

        └── test                    # Test classes

    .build.gradle                   # Gradle build file

    .settings.gradle                # Gradle settings file

### Third-party libs ###

    fasterxml.jackson   (implementation)

    lombok              (compile)

    junit5              (test)

### Setup Requirements ###

1. Java 8+

2. Gradle 6.x+

### Who do I talk to? ###

* Repo owner or admin

* Other community or team contact