Loads and renders maps authored in Tiled (.tmj) with chunk streaming

Repository: github.com/dekiengine/deki-tiledmapeditor-integration · Latest release: 1.2.0 · Needs engine 1.2.0+ · Requires: deki-2d, deki-rendering

Install: DekiEditor --packages-add deki-tiledmapeditor-integration <project>, or add it in the Package Manager. Part of Deki; the engine's own components and the C++ API are documented there.

Shown in the editor as Tiled Map Editor Integration.

Components

Component	Category	Description
TilemapColliderComponent	Tilemap	Exposes a tilemap layer's per-tile collision shapes for queries.
TilemapComponent	Tilemap	Draws a Tiled map, streaming chunks in around the camera.
TilemapObjectSpawner	Tilemap	Spawns objects from a Tiled map's object layers when the scene loads.

Feature flags

Compile-time features the package exposes (package.json):

Feature	Define	Default
Tilemap Rendering	DEKI_FEATURE_TILEMAP_RENDER	on
Tilemap Collision	DEKI_FEATURE_TILEMAP_COLLISION	on
Object Layers	DEKI_FEATURE_TILEMAP_OBJECTS	on

Component reference

TilemapColliderComponent

Exposes a tilemap layer's per-tile collision shapes for queries.

Inspector name: Tilemap Collider Component · Category: Tilemap · Type GUID: e2b8c4a1-9f30-4d65-8c11-7a4b3e2d1f88

Property	Type	Default	Constraints
tilemap	AssetRef (Tilemap)	""
collisionLayer	int32	0
loopX	bool	false
wrapPeriodX	int32	0	shown when loopX allows
loopY	bool	false
wrapPeriodY	int32	0	shown when loopY allows

TilemapComponent

Draws a Tiled map, streaming chunks in around the camera.

Inspector name: Tilemap Component · Category: Tilemap · Type GUID: 7c9a1d20-3e44-4b8a-9f12-6d2c5e3a8b71

Property	Type	Default	Constraints
tilemap	AssetRef (Tilemap)	""
visibleLayerMask	int32	2147483647
chunkPadding	int32	1
tintColor	Color	0xFFFFFFFF
pixelsPerMeter	float	16	1 to 256
loopX	bool	false
wrapPeriodX	int32	0	shown when loopX allows
loopY	bool	false
wrapPeriodY	int32	0	shown when loopY allows

Inherits sortingOrder, ignoreClip, pixelSnap, alphaMode from RendererComponent.

TilemapObjectSpawner

Spawns objects from a Tiled map's object layers when the scene loads.

Inspector name: Tilemap Object Spawner · Category: Tilemap · Type GUID: a4f2b6c8-5d10-4e93-bc77-2f8a9d3c4e15

Property	Type	Default	Constraints	Description
tilemap	AssetRef (Tilemap)	""
pixelsPerMeter	float	16	1 to 256

Generated from the package's reflection metadata by the Deki documentation build (engine 1.3.0). Reflected property names are the keys scene files use; a rename ships with an alias, see COMPATIBILITY.md.