Page tree

This page has not yet been translated to English.

Skip to end of metadata
Go to start of metadata

Exporting all/partial game data to a specified file.

Example:

Charon.exe DATA EXPORT --dataBase c:\myapp\gamedata.json --entities Character Item --attributes Name Description --output c:\myapp\character_and_item_names.json --outputFormat json

Command parameters

ParameterTypeRequiredDescriptionExample
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
entities

list of strings

no

A list of entities to export. Documents are selected from the root list of entities. Embedded documents will be included in export. You can prevent that by removing attributes with Document & Document list types.

  • You can use wildcards (*) in the beginning and in the end of names.
  • You can use identifier in { } instead of entity name.
  • You can exclude certain names by using exclamaiton mark (!).

Default: all entities.

Character
Char*
*Modifier
*Mod*
{18d4bf318f3c49688087dbed}
Char* !Character
!*Item*

attributes

list of strings

no1

List of attributes to export.

  • You can use wildcards (*) in the beginning and in the end of attribues.
  • You can use identifier in { } instead of an attribute name.
  • You can use data type in []
  • You can apply exclusion filter by using exclamaiton mark (!).

Default: all attributes.

Name
*Modifier
*Mod*
{18d4bf318f3c49688087dbed}
[Text]
Description ![LocalizedText]
!*Form*

languages

list of languages

no1

List of languages to export.

  • You can use wildcards (*) in the beginning and in the end of a language.
  • You can use identifier in { } instead of a language name.
  • You can apply exclusion filter by using exclamaiton mark (!).

Default: all languages.

"Spanish (Spain)"
Spanish*
{es-Es}
{3082}

!Spanish*
Spanish* !{es-Es}

output

file, err, null, out, url

no

Path to a file to which data will be exported. 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 & URL.

Default: out.

"c:\my app\output.json"
/User/Data/output.json
http://example.com/push/
ftp://example.com/data.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. Depend on selected data format.


mode

list: Default, Publication

no

Export mode:

  • Default - standard export
  • Publication - exporting only 'published' data (IsPublished = true).

Default: Default.


1 Only partial data will be exported. It is recommended to import partial data using SafeUpdate mode.

Related pages