Page tree

This page has not yet been translated to English.

Skip to end of metadata
Go to start of metadata

Checking game data for errors

Пример:

Charon.exe DATA VALIDATE --dataBase c:\myapp\gamedata.json --validationOptions FixErrors --output "c:\my app\report.json" --outputFormat json

Command parameters

Parameter

Type

Required

Description

Example

dataBase

string

yes

Path to game data file. Use quotation marks if your path contains spaces.

"c:\my app\gamedata.json"
/User/Data/gamedata.json
validationOptions

multiple-choice list None, Repair

no

Additional validation parameters:

  • None - Only check data
  • Repair - Try to repair invalid data by replacing  with default values, removing invalid values and references. 

Default: Repair

None

output

file, err, null, out

no

Path to the file to which report will be written. If the file exists, it will be overwritten. The directory must already exist. Alternatively, you can use output to Standart Error, Standart Output & dev/null.
Default: out.

"c:\my app\report.json"
/User/Data/report.json
outputFormat

json, bson, msgpack, xml, xlsx

no

Format to use when saving game data. See Supported data formats for more information.

Default: json.


outputFormattingOptions

See Supported data formats

no

Additional formatting parameters for output data. Depend on selected data format.


Report formatting

Report is structured in the following way:

Object
	"items": Array
		Object
			"id": "<id>"
			"entityId": "<entity id>"
			"entityName": "<entity name>"
			"errors": Array
                Object
					"path": "<logical path to field>"
					"msg": "<error message>"
					"type": <error code>
                EndOfObject
				// ...
	        EndOfArray
        EndOfObject
	EndOfArray
EndOfObject

Related pages