Create Backup

Backs up game data to a specified file. Saved data could be later used with DATA RESTORE command.

Also this command can be used to convert game data into different format.

• CLI Installation

• Commands Reference

• Universal Parameters

• URL-based Input/Output

Command

# local game data (windows)
Charon.exe DATA BACKUP --dataBase "c:\my app\gamedata.json" --output "c:\my app\backup.msgpkg" --outputFormat msgpack

# remote game data
Charon.exe DATA BACKUP --dataBase "https://charon.live/view/data/My_Game/develop/" --output "./backup.msgpkg" --outputFormat msgpack --credentials "<API-Key>"

Parameters

--dataBase

Absolute or relative path to game data. Use quotation marks if your path contains spaces.

# local file
--dataBase "c:\my app\gamedata.json"

# remote server
--dataBase "https://charon.live/view/data/My_Game/develop/"

--credentials

The API key used to access remote server in case of –dataBase being URL.

--output

Path to a backup file. If the file exists, it will be overwritten. The directory must already exist. Alternatively, you can output to Standard Error, Standard Output, /dev/null, or a URL.

# standart output (default)
--output out
--output con

# standart error
--output err

# null device
--output null

# absolute path (windows)
--output "c:\my app\backup.json"

# absolute path (unix)
--output "/user/data/backup.json"

# relative path (universal)
--output "./backup.json"

# remote location (HTTP)
--output "http://example.com/backup.json"

# remote location with authentication (FTP)
--output "ftp://user:password@example.com/backup.json"

--outputFormat

Format of backed up data.

# JSON (default)
--outputFormat json

# Message Pack
--outputFormat msgpack

--outputFormattingOptions

Additional options for specified format.

This command supports universal parameters.

Output Data Schema

The backed-up data follows the schema of game data.