Skip to content

Command Line Parameters

Dmitry Serov edited this page Nov 30, 2016 · 4 revisions

Main application can be executed with the command line parameters, and this page contains brief description of this feature.

Help

./cataclysm --help lists all available parameters:

Command line parameters:
--seed <string of letters and or numbers>
	Sets the random number generator's seed value
--jsonverify
	Checks the cdda json files
--check-mods [mods...]
	Checks the json files belonging to cdda mods
--dump-stats <what> [mode = TSV] [opts...]
	Dumps item stats
--world <name>
	Load world
--basepath <path>
	Base path for all game data subdirectories
--datadir <directory name>
	Sub directory from which game data is loaded
--autopickupfile <filename>
	Name of the autopickup options file within the configdir
--motdfile <filename>
	Name of the message of the day file within the motd directory

Map sharing
--shared
	Activates the map-sharing mode
--username <name>
	Instructs map-sharing code to use this name for your character.
--addadmin <username>
	Instructs map-sharing code to use this name for your character and give you access to the cheat functions.
--adddebugger <username>
	Informs map-sharing code that you're running inside a debugger
--competitive
	Instructs map-sharing code to disable access to the in-game cheat functions
--worldmenu
	Enables the world menu in the map-sharing code

User directories
--userdir <path>
	Base path for user-overrides to files from the ./data directory and named below
--savedir <directory name>
	Subdirectory for game saves
--configdir <directory name>
	Subdirectory for game configuration
--memorialdir <directory name>
	Subdirectory for memorials
--optionfile <filename>
	Name of the options file within the configdir
--keymapfile <filename>
	Name of the keymap file within the configdir

Check Mods

TBD

Dump Stats

--dump-stats parameter allows you to dump game data (loaded from JSON files) in format convenient for further use.

For each report the game creates a default instance of each object (inclusive of any default ammo, contents or mods).

The syntax is --dump-stats <what> [mode], and all possible options are described in the following sub-sections.

What

The following output reports are supported:

  • AMMO
  • EDIBLE
  • GUN
  • VEHICLE
  • VPART
  • RECIPE

Mode

Optional field for request exact format of output:

TSV (Tab Separated Values format)

Example of output: /TBD/

HTML(Hyper Text Markup Language format)

/TBD/

Example of output: /TBD/

Opts

/TBD/

Clone this wiki locally