Skip to content

Commit

Permalink
UPD docs
Browse files Browse the repository at this point in the history
  • Loading branch information
deepnight committed Aug 29, 2024
1 parent 96bef0d commit 5d8cb7d
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 3 deletions.
3 changes: 2 additions & 1 deletion docs/JSON_DOC.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,12 +41,13 @@ Value | Type | Description
`flags`<br/><sup class="internal">*Only used by editor*</sup><br/> ![Generic badge](https://img.shields.io/badge/Added_0.8.0-gray.svg) | Array&nbsp;of&nbsp;Enum | An array containing various advanced flags (ie. options or other states).<br/> Possible values: `DiscardPreCsvIntGrid`, `ExportOldTableOfContentData`, `ExportPreCsvIntGridFormat`, `IgnoreBackupSuggest`, `PrependIndexToLevelFileNames`, `MultiWorlds`, `UseMultilinesType`
`identifierStyle`<br/><sup class="internal">*Only used by editor*</sup><br/> ![Generic badge](https://img.shields.io/badge/Added_1.0.0-gray.svg) | Enum | Naming convention for Identifiers (first-letter uppercase, full uppercase etc.)<br/> Possible values: `Capitalize`, `Uppercase`, `Lowercase`, `Free`
`imageExportMode`<br/><sup class="internal">*Only used by editor*</sup><br/> ![Generic badge](https://img.shields.io/badge/Added_0.9.3-gray.svg) | Enum | "Image export" option when saving project.<br/> Possible values: `None`, `OneImagePerLayer`, `OneImagePerLevel`, `LayersAndLevels`
`jsonStyle`<br/><sup class="internal">*Only used by editor*</sup> | Enum | JSON style<br/> Possible values: `Minified`, `Compact`, `Full`
`levelNamePattern`<br/><sup class="internal">*Only used by editor*</sup><br/> ![Generic badge](https://img.shields.io/badge/Added_0.9.0-gray.svg) | String | The default naming convention for level identifiers.
`minifyJson`<br/><sup class="internal">*Only used by editor*</sup> | Bool | If TRUE, the Json is partially minified (no indentation, nor line breaks, default is FALSE)
`nextUid`<br/><sup class="internal">*Only used by editor*</sup> | Int | Next Unique integer ID available
`pngFilePattern`<br/><sup class="internal">*Only used by editor*</sup><br/> ![Generic badge](https://img.shields.io/badge/Added_0.7.2-gray.svg) | String&nbsp;*(can&nbsp;be&nbsp;`null`)* | File naming pattern for exported PNGs
`simplifiedExport`<br/><sup class="internal">*Only used by editor*</sup><br/> ![Generic badge](https://img.shields.io/badge/Added_1.1.0-gray.svg) | Bool | If TRUE, a very simplified will be generated on saving, for quicker & easier engine integration.
`tutorialDesc`<br/><sup class="internal">*Only used by editor*</sup><br/> ![Generic badge](https://img.shields.io/badge/Added_1.0.0-gray.svg) | String&nbsp;*(can&nbsp;be&nbsp;`null`)* | This optional description is used by LDtk Samples to show up some informations and instructions.
~~`minifyJson`~~<br/><sup class="internal">*Only used by editor*</sup><br/><sup class="deprecated">*DEPRECATED!*</sup><br/> | Bool | **WARNING**: this deprecated value will be *removed* completely on version 1.7.0+<br/> <br/> Replaced by: `jsonStyle`
~~`exportPng`~~<br/><sup class="internal">*Only used by editor*</sup><br/><sup class="deprecated">*DEPRECATED!*</sup><br/> ![Generic badge](https://img.shields.io/badge/Removed_0.9.3-gray.svg) | Bool&nbsp;*(can&nbsp;be&nbsp;`null`)* | **WARNING**: this deprecated value is no longer exported since version 0.9.3<br/> <br/> Replaced by: `imageExportMode`

<a id="ldtk-WorldJson" name="ldtk-WorldJson"></a>
Expand Down
12 changes: 10 additions & 2 deletions docs/JSON_SCHEMA.json
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,8 @@
"flags",
"identifierStyle",
"imageExportMode",
"jsonStyle",
"levelNamePattern",
"minifyJson",
"nextUid",
"simplifiedExport"
],
Expand Down Expand Up @@ -328,6 +328,14 @@
"array"
]
},
"jsonStyle": {
"description": "JSON style Possible values: `Minified`, `Compact`, `Full`",
"enum": [
"Minified",
"Compact",
"Full"
]
},
"jsonVersion": {
"description": "File format version",
"type": [
Expand Down Expand Up @@ -373,7 +381,7 @@
]
},
"minifyJson": {
"description": "If TRUE, the Json is partially minified (no indentation, nor line breaks, default is FALSE)",
"description": "**WARNING**: this deprecated value will be *removed* completely on version 1.7.0+ Replaced by: `jsonStyle`",
"type": [
"boolean"
]
Expand Down

0 comments on commit 5d8cb7d

Please # to comment.