Crate ldtk_rust

This library parses JSON generated by LDtk (Level Designers ToolKit) for use in Rust. It is designed to be usable in any Rust program, including all game frameworks.

Most users will want to start by reviewing the top level Project struct and in particular the Project::new() method. Calling this method will load in all of your LDtk data. See the library’s /examples subdirectory for more detailed examples.

Project::new(f: String) --- loads all the data
Project::load_project(f: String) --- loads only the project file
Level::new(f: String) --- loads a single external level file

Structs

AutoLayerRuleDefinition	This complex section isn’t meant to be used by game devs at all, as these rules are completely resolved internally by the editor before any saving. You should just ignore this part.
AutoLayerRuleGroup
Definitions	A structure containing all the definitions of this project
EntityDefinition
EntityInstance
EntityInstanceTile	Tile data in an Entity instance
EnumDefinition
EnumValueDefinition
FieldDefinition	This section is mostly only intended for the LDtk editor app itself. You can safely ignore it.
FieldInstance
IntGridValueDefinition	IntGrid value definition
IntGridValueInstance	IntGrid value instance
LayerDefinition
LayerInstance
LdtkJson	Deprecated
Level	This section contains all the level data. It can be found in 2 distinct forms, depending on Project current settings: - If “Separate level files” is disabled (default): full level data is embedded inside the main Project JSON file, - If “Separate level files” is enabled: level data is stored in separate standalone .ldtkl files (one per level). In this case, the main Project JSON file will still contain most level data, except heavy sections, like the layerInstances array (which will be null). The externalRelPath string points to the ldtkl file. A ldtkl file is just a JSON file containing exactly what is described below.
LevelBackgroundPosition	Level background image position info
NeighbourLevel	Nearby level info
Project	This file is a JSON schema of files created by LDtk level editor (https://ldtk.io).
TileInstance	This structure represents a single tile from a given Tileset.
TilesetDefinition	The Tileset definition is the most important part among project definitions. It contains some extra informations about each integrated tileset. If you only had to parse one definition section, that would be the one.

Enums

BgPos
Checker	Checker mode Possible values: None, Horizontal, Vertical
EditorDisplayMode	Possible values: Hidden, ValueOnly, NameAndValue, EntityTile, Points, PointStar, PointPath, PointPathLoop, RadiusPx, RadiusGrid
EditorDisplayPos	Possible values: Above, Center, Beneath
Flag
LimitBehavior	Possible values: DiscardOldOnes, PreventAdding, MoveLastOne
LimitScope	If TRUE, the maxCount is a “per world” limit, if FALSE, it’s a “per level”. Possible values: PerLayer, PerLevel, PerWorld
RenderMode	Possible values: Rectangle, Ellipse, Tile, Cross
TextLangageMode
TileMode	Defines how tileIds array is used Possible values: Single, Stamp
TileRenderMode	Possible values: Cover, FitInside, Repeat, Stretch
Type	Type of the layer as Haxe Enum Possible values: IntGrid, Entities, Tiles, AutoLayer
WorldLayout	An enum that describes how levels are organized in this project (ie. linearly or in a 2D space). Possible values: Free, GridVania, LinearHorizontal, LinearVertical