Command line and version

Command-line options

To play, you need at most one argument: the WinData folder (banished PATH). The other commands run without a window and then stop. They are for testing, and for the screenshots and videos in these documents:

Command	Effect
banished PATH	play, reading the game data from this WinData folder
banished --version	show the Un-Banished version (see Version) and stop
banished --record FILE …	record every command of the next game you load from a save (add it to any of the other commands, or to banished PATH)
banished --replay SAVE FILE	play a recording again from its save, and check that the game comes out the same
banished --sim-digest SAVE	run a save and print checksums of the game state, to compare with the browser version
banished --boot-capture FILE.png SECONDS	start the game, run it for SECONDS and save that frame
banished --capture FILE.png [options]	generate a map and save a picture of it

Options for the captures: --seed N, --terrain NAME, --size 0|1|2, --month 0..11, --view overview, --ui-scale PERCENT and --setting KEY=VALUE (a stored setting by its original name, such as VideoReflectionDetail=2). Captures do not use your saved settings. --boot-capture can also click, drag, type, move the camera and take screenshots at given times; the game's README lists every option, and Recording videos shows how to use them.

The other programs:

Program	What it is
banished-mods [PATH]	the mod manager
banished-cli nexus …, banished-cli banishedinfo …	search and install mods from the command line (see Mods and the CLI README)
banished-relay [ADDRESS]	the multiplayer relay (see Multiplayer and the relay's README)

Environment variables: BANISHED_USER_DIR (the folder that holds Save), BANISHED_SETTINGS (the settings file), RUST_LOG (how much detail the log shows, for example RUST_LOG=debug), BANISHED_PROFILE=1 (logs slow frames and frame-time summaries; in the browser, add ?profile to the address), BANISHED_THREADS=N (how many threads loading uses; the default is one per CPU core, and 1 loads everything on one thread), BANISHED_NEXUS_API_KEY (your Nexus Mods API key; see Mods from Nexus Mods). See PERFORMANCE.md.

Version

Un-Banished has its own version number, for example 0.2.0-1382712. The first part is the release: a released version, or the next release while it is in development (see CHANGELOG.md). The second part is the build: the first seven characters of the git commit the program was built from. -dirty at the end means that the program was built with changes that were not committed. unknown means that the build could not be found, for example in a build from a source archive without git.

You can see the version in these places:

• banished --version shows it, for example Un-Banished 0.2.0-1382712.
• The first line of the log, when the game starts.
• In the browser: at the foot of the loading screen, and in the browser's console.
• On the website, at the bottom of the pages.

The main menu shows "Version 1.0.7 - Build 170910". That is the version of Banished, from the game data. It does not change. Give both versions when you report a problem.