Repository navigation
reference api tiled tileset
cheaterbob edited this page Oct 3, 2026
·
1 revision
Generated from
tiled-tileset.schema.json. Runtime validation remains authoritative for cross-file and engine-dependent rules.
Experimental schema for an external Tiled JSON/TSJ tileset referenced by a Mod API v1 authored map. Tiled-owned editor metadata remains open.
| Field | Type | Required | Stability | Constraints and meaning |
|---|---|---|---|---|
type |
const: tileset
|
yes | experimental | |
name |
string | yes | experimental | min length: 1
|
tilewidth |
integer | yes | experimental | min: 1; max: 1000000
|
tileheight |
integer | yes | experimental | min: 1; max: 1000000
|
tilecount |
integer | yes | experimental | min: 1; max: 1000000
|
columns |
integer | yes | experimental | min: 1; max: 1000000
|
spacing |
integer | no | experimental | min: 0; default: 0
|
margin |
integer | no | experimental | min: 0; default: 0
|
image |
ref: pngPath
|
yes | experimental | |
imagewidth |
integer | yes | experimental | min: 1
|
imageheight |
integer | yes | experimental | min: 1
|
objectalignment |
enum: unspecified, topleft, top, topright, left, center, right, bottomleft, bottom, bottomright
|
no | experimental | |
tiles |
array of ref: tile
|
no | experimental | |
properties |
array of ref: property
|
no | experimental | |
version |
string number | no | experimental | |
tiledversion |
string | no | experimental |
Schema form: string.
Constraints: pattern: ^(?!/)(?![A-Za-z]:)(?!.*\\).+\.[pP][nN][gG]$.
| Field | Type | Required | Stability | Constraints and meaning |
|---|---|---|---|---|
| No named properties | This definition is composed through references or conditional schemas. |
Schema form: object.
| Field | Type | Required | Stability | Constraints and meaning |
|---|---|---|---|---|
id |
integer | yes | min: 0
|
|
animation |
array of ref: frame
|
no | min items: 2; max items: 256
|
Schema form: object.
| Field | Type | Required | Stability | Constraints and meaning |
|---|---|---|---|---|
tileid |
integer | yes | min: 0
|
|
duration |
integer | yes | min: 16; max: 60000
|
Schema form: object.
| Field | Type | Required | Stability | Constraints and meaning |
|---|---|---|---|---|
name |
string | yes | min length: 1
|
|
type |
enum: string, file, bool, int, float, color
|
yes | ||
value |
schema | yes |
Published from Docs/Modding/Public. The repository documentation is the canonical source.
Captivity Reloaded wiki* Captivity Reloaded Wiki
- Getting started
- Core concepts
- Content types
- Authoring tools
-
Reference
- Example pack index
- Schema index
- Field-by-field API reference
- Public asset-slot catalog
- Core enemy asset slots
- Validation and errors
- Validation/error-code catalog
- Mod API changelog
- Migration guides
- Troubleshooting
- Glossary
- Defaults and compatibility
- Resource limits
- Mod-author test matrix
- Implementation status
- Mod API v1 release checklist
- Release verification runbook
- Release evidence template
- Licensing and redistribution
- Development