Project Settings

Added in version 2026.4.0.

Retrieves the project settings document (languages, primary language, and other project-level configuration) from game data.

Command

# local game data (windows)
dnx dotnet-charon -- DATA PROJECTSETTINGS \
  --dataBase "c:\my app\gamedata.json"

# remote game data
dnx dotnet-charon -- DATA PROJECTSETTINGS \
  --dataBase "https://charon.live/view/data/My_Game/develop/" \
  --credentials "<API-Key>"

There is always exactly one project settings document per game data source, so unlike DATA FIND this command takes no --schema/--id parameters - its identity is fixed internally.

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 the retrieved document 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.

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

# standard error
--output err

# null device
--output null

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

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

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

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

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

Specifies the format of the output data.

# JSON (default)
--outputFormat json

# BSON
--outputFormat bson

# Message Pack
--outputFormat msgpack
--outputFormattingOptions

Additional options for formatting the output.

This command supports universal parameters.

Output

Outputs the project settings document. See the Project Settings section for the full field reference.

{
  "Id": "55a4f32faca22e191098f3d9",
  "Name": "My Project",
  "PrimaryLanguage": "en-US",
  "Languages": "en-GB;fr-FR",
  "Copyright": "My Company (c) 2025",
  "Version": "1.0.0.0"
}

See also