From 5d8cb7d5ca454a513e7c4939146c1dc41751e000 Mon Sep 17 00:00:00 2001 From: Sebastien Benard Date: Thu, 29 Aug 2024 16:18:02 +0200 Subject: [PATCH] UPD docs --- docs/JSON_DOC.md | 3 ++- docs/JSON_SCHEMA.json | 12 ++++++++++-- 2 files changed, 12 insertions(+), 3 deletions(-) diff --git a/docs/JSON_DOC.md b/docs/JSON_DOC.md index effefac79..9ce491651 100644 --- a/docs/JSON_DOC.md +++ b/docs/JSON_DOC.md @@ -41,12 +41,13 @@ Value | Type | Description `flags`
*Only used by editor*
![Generic badge](https://img.shields.io/badge/Added_0.8.0-gray.svg) | Array of Enum | An array containing various advanced flags (ie. options or other states).
Possible values: `DiscardPreCsvIntGrid`, `ExportOldTableOfContentData`, `ExportPreCsvIntGridFormat`, `IgnoreBackupSuggest`, `PrependIndexToLevelFileNames`, `MultiWorlds`, `UseMultilinesType` `identifierStyle`
*Only used by editor*
![Generic badge](https://img.shields.io/badge/Added_1.0.0-gray.svg) | Enum | Naming convention for Identifiers (first-letter uppercase, full uppercase etc.)
Possible values: `Capitalize`, `Uppercase`, `Lowercase`, `Free` `imageExportMode`
*Only used by editor*
![Generic badge](https://img.shields.io/badge/Added_0.9.3-gray.svg) | Enum | "Image export" option when saving project.
Possible values: `None`, `OneImagePerLayer`, `OneImagePerLevel`, `LayersAndLevels` +`jsonStyle`
*Only used by editor* | Enum | JSON style
Possible values: `Minified`, `Compact`, `Full` `levelNamePattern`
*Only used by editor*
![Generic badge](https://img.shields.io/badge/Added_0.9.0-gray.svg) | String | The default naming convention for level identifiers. -`minifyJson`
*Only used by editor* | Bool | If TRUE, the Json is partially minified (no indentation, nor line breaks, default is FALSE) `nextUid`
*Only used by editor* | Int | Next Unique integer ID available `pngFilePattern`
*Only used by editor*
![Generic badge](https://img.shields.io/badge/Added_0.7.2-gray.svg) | String *(can be `null`)* | File naming pattern for exported PNGs `simplifiedExport`
*Only used by editor*
![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`
*Only used by editor*
![Generic badge](https://img.shields.io/badge/Added_1.0.0-gray.svg) | String *(can be `null`)* | This optional description is used by LDtk Samples to show up some informations and instructions. +~~`minifyJson`~~
*Only used by editor*
*DEPRECATED!*
| Bool | **WARNING**: this deprecated value will be *removed* completely on version 1.7.0+

Replaced by: `jsonStyle` ~~`exportPng`~~
*Only used by editor*
*DEPRECATED!*
![Generic badge](https://img.shields.io/badge/Removed_0.9.3-gray.svg) | Bool *(can be `null`)* | **WARNING**: this deprecated value is no longer exported since version 0.9.3

Replaced by: `imageExportMode` diff --git a/docs/JSON_SCHEMA.json b/docs/JSON_SCHEMA.json index ed03ea6c6..0689b13c4 100644 --- a/docs/JSON_SCHEMA.json +++ b/docs/JSON_SCHEMA.json @@ -32,8 +32,8 @@ "flags", "identifierStyle", "imageExportMode", + "jsonStyle", "levelNamePattern", - "minifyJson", "nextUid", "simplifiedExport" ], @@ -328,6 +328,14 @@ "array" ] }, + "jsonStyle": { + "description": "JSON style Possible values: `Minified`, `Compact`, `Full`", + "enum": [ + "Minified", + "Compact", + "Full" + ] + }, "jsonVersion": { "description": "File format version", "type": [ @@ -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" ]