LDtk Rust Library

Crates.io Docs.rs

ldtk_rust enables access to LDtk data for use in Rust. LDtk is a 2D level editor for games that supports multiple tile layers, powerful auto-tiling rules, entity placement and more.

Status

This library works with LDtk version 0.9.2 and supports the optional external level files. LDtk updates save files automatically, so there's no reason to be on an older version, but if you are (or if you get a new version before this crate is updated) you can follow the process below to generate code against whatever LDtk version you want to use.

Getting Started

Calling the new() method on the LdtkFile struct with the path to a LDtk file will populate a struct that closely resembles the LDtk JSON format.

```rust use ldtk_rust::Project;

fn main() { let filepath = "assets/testgame.ldtk".tostring(); let ldtk = Project::new(filepath); println!("First level pixel height is {}!", ldtk.levels[0].px_hei); } ```

Your editor's auto-complete should help you visualize your options, or you can generate API docs with "cargo doc --open" or view them here.

Run the Examples

You can run the programs in the example folder using cargo:

```bash

cargo run --example basic ```

Example dependencies do not load when compiling the library for production.

Using in a Real Game

An example running in Bevy Engine is included in the examples directory. There are lots of comments, and the focus of the example is on the process, not the Bevy-specific code. If you are using another game engine the example will hopefully still be understandable and useful.

Using Other Versions of LDtk (older or newer)

LDtk includes a JSON schema that can be used to auto-generate RUST code to unmarshal the JSON. Alls you do is:

  1. Clone this project
  2. Check the /src subdirectory to see if there is already auto-generated code for the version you want to use. If so, skip to #7 below. If not, you're going to create a new file for the version you want to use.
  3. Copy the version of the Schema file from the LDtk Github that corresponds to your version and paste it into the quicktype web tool. The Schema is in the docs/ directory.
  4. On the left, set the "name" to "Project" and the "Source type" to "JSON Schema"
  5. On the right choose the Rust language and set field visibility to "Public".
  6. Save the resulting file to the /src subdirectory of this project
  7. Change the serde import line near the top of the file to "use serde::*;". You can view the other .rs version files to see this.
  8. Change the mod and pub use lines at the top of lib.rs (in the same directory you're working in already) to include your new file instead.

You'll need to adjust your Carto.toml file to use your project instead of this one (or contribute your change back here).

At this point you can look at lib.rs and decide if you really even want this project wrapping the autogenerated code, or if you want to just include it in your own project. As LDtk nears 1.0 the JSON Schema is getting better and using this process has become easier.

Implementation Details

Other Options