freeorion(6)

NAME
FreeOrion - turn-based space empire and galactic conquest game

SYNOPSIS
freeorion [OPTIONS]

DESCRIPTION
FreeOrion is a turn-based space empire and galactic conquest (4X) computer game being designed and built by the FreeOrion project. FreeOrion is inspired by the tradition of the Master of Orion games, but is not a clone or remake of that series or any other game. The game is about the construction of a living, breathing universe in a grand campaign model. You can develop your own galactic empire and explore new star systems with your fleets as one of several unique human or alien species. Colonization of new worlds, researching new technology, managing your resources and defending your planets against the AI or other human players on a galactic scale are your main objectives.

OPTIONS
--GameSetup.ai-players

    The number of AI opponents in the game. Default: 3

--GameSetup.empire-color

    The color used in the game for your empire. Default: 0

--GameSetup.empire-name

    The name used in the game for your empire. Default:

--GameSetup.galaxy-age

    The age of the galaxy to be generated. Default: GALAXY_SETUP_MEDIUM

--GameSetup.galaxy-shape

    The shape of the galaxy to be generated. Default: SPIRAL_3

--GameSetup.monster-frequency

    The frequency of monsters in the galaxy to be generated. Default: GALAXY_SETUP_MEDIUM

--GameSetup.native-frequency

    The frequency of natives in the galaxy to be generated. Default: GALAXY_SETUP_MEDIUM

--GameSetup.planet-density

    The number of planets per system in the galaxy to be generated. Default: GALAXY_SETUP_MEDIUM

--GameSetup.player-name

    The name used in the game to represent the player in single player games. Default:

--GameSetup.specials-frequency

    The frequency of specials appearing in the galaxy to be generated. Default: GALAXY_SETUP_MEDIUM

--GameSetup.starlane-frequency

    The number of starlanes in the galaxy to be generated. Default: GALAXY_SETUP_MEDIUM

--GameSetup.stars

    The number of systems in the galaxy to be generated. Default: 61

--GameSetup.starting-species

    The species on your homeworld at the start of the game. Default: SP_HUMAN

--UI.autogenerated-effects-descriptions

    Toggles inclusion of auto-generated text in tech, building or ship part descriptions. Default: 0

--UI.ctrl-border-color

    Sets UI control border color. Default: (124,124,124,255)

--UI.ctrl-color

    Sets UI control background color. Default: (15,15,15,255)

--UI.default-link-color

    Sets UI default link color. Default: (80,255,128,255)

--UI.dropdownlist-arrow-color

    Sets UI drop-down-list arrow color. Default: (130,130,0,255)

--UI.edit-hilite

    Sets color of highlighting in UI edit controls. Default: (43,81,102,255)

--UI.fleet-autoselect

    Auto-select the top fleet when a fleet window is opened. Consider using this flag if you use UI.multiple-fleet-windows. Default: 1

--UI.fleet-selection-indicator-size

    Sets size of fleet selection indicator, relative to fleet icon size. Default: 1.625

--UI.fleet-supply-line-dot-rate

    Sets how fast to render dots for fleet supply lines. Default: 0.02

--UI.fleet-supply-line-dot-spacing

    Sets how far apart to render dots for fleet supply lines. Default: 20

--UI.fleet-supply-line-width

    Sets how wide to render fleet supply lines. Default: 3

--UI.fleet-supply-lines

    Toggles whether to show fleet supply lines with empire-colored indicators. Default: 1

--UI.font

    Sets UI font resource file.

--UI.font-bold

    Sets UI bold font resource file.

--UI.font-size

    Sets UI font size. Default: 12

--UI.galaxy-gas-background

    Render gassy substance around systems to give galaxy shape. May slow rendering on older systems. Default: 1

--UI.galaxy-starfields

    Render star fields around systems. May slow rendering on older systems. Default: 1

--UI.known-tech

    Sets color of known techs in the tech tree. Default: (72,72,72,255)

--UI.known-tech-border

    Sets text and border color of known techs in the tech tree. Default: (164,164,164,255)

--UI.main-menu.x

    Position of the center of the intro screen main menu, as a portion of the application's total width. Default: 0.75

--UI.main-menu.y

    Position of the center of the intro screen main menu, as a portion of the application's total height. Default: 0.5

--UI.map-right-click-popup-menu

    Toggles whether to show a right-click popup menu on the galaxy map. Default: 0

--UI.medium-fleet-button-minimum-zoom

    Sets minimum zoom level at which medium fleet icons are shown on the galaxy map. Default: 4

--UI.multiple-fleet-windows

    If true, clicks on multiple fleet buttons will open multiple fleet windows at the same time. Otherwise, opening a fleet window will close any currently-open fleet window. Default: 0

--UI.optimized-system-rendering

    Use fancy optimized OpenGL 1.5 rendering for systems on galaxy map. May crash on older graphics hardware. Default: 1

--UI.researchable-tech

    Sets color of researchable techs in the tech tree. Default: (48,48,48,255)

--UI.researchable-tech-border

    Sets text and border color of researchable techs in the tech tree. Default: (164,164,164,255)

--UI.resource-starlane-colouring

    Toggles whether to color starlanes with empire colors if empires can exchange resources along each starlane. Default: 1

--UI.rollover-link-color

    Sets UI rollover link color. Default: (192,80,255,255)

--UI.scroll-width

    Sets UI scroll width. Default: 14

--UI.show-detection-range

    Toggles whether to show circles around objects to indicate their detection range on the galaxy map. Default: 0

--UI.show-galaxy-map-scale

    Show scale line for universe distance on galaxy map. Default: 1

--UI.show-galaxy-map-zoom-slider

    Toggles whether to show the zoom slider on galaxy map. Default: 0

--UI.sidepanel-planet-max-diameter

    Sets size of largest-rendered rotating planets on side-panel. Default: 128

--UI.sidepanel-planet-min-diameter

    Sets size of smallest-rendered rotating planets on side-panel. Default: 24

--UI.sidepanel-planet-shown

    Sets whether to show rendered planets / asteroids on the side-panel. Default: 1

--UI.sidepanel-width

    Sets size of system side-panel. Default: 384

--UI.small-fleet-button-minimum-zoom

    Sets minimum zoom level at which small fleet icons are shown on the galaxy map. Default: 1.5

--UI.sound.alert

    The sound file played when an error or illegal action occurs.

    Default: /usr/share/games/freeorion/default/data/sound/alert.wav

--UI.sound.balanced-focus

    The sound file played when a balanced focus button is clicked.

    Default: /usr/share/games/freeorion/default/data/sound/balanced_select.wav

--UI.sound.bg-music

    Sets the background track to play.

    Default: /usr/share/games/freeorion/default/data/sound/artificial_intelligence_v3.ogg

--UI.sound.button-click

    The sound file played when a button is clicked.

    Default: /usr/share/games/freeorion/default/data/sound/button_click.wav

--UI.sound.button-rollover

    The sound file played when the mouse moves over a button.

    Default: /usr/share/games/freeorion/default/data/sound/button_rollover.wav

--UI.sound.enabled

    Enables sound in the game. Default: 1

--UI.sound.farming-focus

    The sound file played when a farming focus button is clicked.

    Default: /usr/share/games/freeorion/default/data/sound/farm_select.wav

--UI.sound.fleet-button-click

    The sound file played when a fleet button is clicked.

--UI.sound.fleet-button-rollover

    The sound file played when the mouse moves over a fleet button.

    Default: /usr/share/games/freeorion/default/data/sound/fleet_button_rollover.wav

--UI.sound.industry-focus

    The sound file played when an industry focus button is clicked.

    Default: /usr/share/games/freeorion/default/data/sound/industry_select.wav

--UI.sound.item-drop

    The sound file played when an item is dropped into a listbox.

    Default: /usr/share/games/freeorion/default/data/sound/item_drop.wav

--UI.sound.list-pulldown

    The sound file played when the list is opened in a drop-down list.

    Default: /usr/share/games/freeorion/default/data/sound/list_pulldown.wav

--UI.sound.list-select

    The sound file played when a listbox or drop-down list item is selected.

    Default: /usr/share/games/freeorion/default/data/sound/list_select.wav

--UI.sound.mining-focus

    The sound file played when a mining focus button is clicked.

    Default: /usr/share/games/freeorion/default/data/sound/mining_select.wav

--UI.sound.music-enabled

    Enables music in the game. Default: 1

--UI.sound.music-volume

    The volume (0 to 255) at which music should be played. Default: 127

--UI.sound.planet-button-click

    The sound file played when a planet button is clicked.

    Default: /usr/share/games/freeorion/default/data/sound/button_click.wav

--UI.sound.research-focus

    The sound file played when a research focus button is clicked.

    Default: /usr/share/games/freeorion/default/data/sound/research_select.wav

--UI.sound.sidepanel-open

    The sound file played when the system side-panel is opened.

    Default: /usr/share/games/freeorion/default/data/sound/sidepanel_open.wav

--UI.sound.system-icon-rollover

    The sound file played when the mouse moves over a system icon.

    Default: /usr/share/games/freeorion/default/data/sound/fleet_button_rollover.wav

--UI.sound.text-typing

    The sound file played when the user types text.

    Default: /usr/share/games/freeorion/default/data/sound/text_typing.wav

--UI.sound.trade-focus

    The sound file played when a trade focus button is clicked.

    Default: /usr/share/games/freeorion/default/data/sound/trade_select.wav

--UI.sound.turn-button-click

    The sound file played when the turn button is clicked.

    Default: /usr/share/games/freeorion/default/data/sound/turn_button_click.wav

--UI.sound.volume

    The volume (0 to 255) at which UI sound effects should be played. Default: 255

--UI.sound.window-close

    The sound file played when a window is closed.

    Default: /usr/share/games/freeorion/default/data/sound/window_close.wav

--UI.sound.window-maximize

    The sound file played when a window is maximized.

    Default: /usr/share/games/freeorion/default/data/sound/window_maximize.wav

--UI.sound.window-minimize

    The sound file played when a window is minimized.

    Default: /usr/share/games/freeorion/default/data/sound/window_minimize.wav

--UI.starlane-core-multiplier

    width multiplier for empire 'core' starlanes. Default: 6

--UI.starlane-thickness

    Sets how wide to render starlanes in pixels. Default: 2

--UI.stat-decrease-color

    Sets color of decreasing statistics Default: (255,0,0,255)

--UI.stat-increase-color

    Sets color of increasing statistics Default: (0,255,0,255)

--UI.state-button-color

    Sets UI state button selected color. Default: (0,127,0,255)

--UI.swap-mouse-lr

    Swaps results of clicking left and right mouse buttons. Default: 0

--UI.system-circle-size

    Sets size of circles around systems on map, relative to system icon size. Default: 1

--UI.system-circles

    Toggles whether to draw circles around systems. Default: 1

--UI.system-fog-of-war

    Toggles whether to render fog of war scan-line shading over system icons. Default: 1

--UI.system-fog-of-war-spacing

    Sets spacing (in pixels) between fog of war scan-lines. Default: 4

--UI.system-icon-size

    Sets size of system icons. Default: 14

--UI.system-name-unowned-color

    Sets color of unowned system names on the galaxy map. Default: (160,160,160,255)

--UI.system-selection-indicator-fps

    Sets the frame rate of animation of system selection indicator. Default: 12

--UI.system-selection-indicator-size

    Sets size of system selection indicator, relative to system icon size. Default: 1.625

--UI.system-tiny-icon-size-threshold

    Sets size of system icons below which the fixed-size tiny icons will be shown. Default: 10

--UI.tech-layout-horz-spacing

    The horizontal spacing to be placed between techs in the tech screen, in multiples of the width of a single theory tech. Default: 0.75

--UI.tech-layout-vert-spacing

    The vertical spacing to be placed between techs in the tech screen, in multiples of the height of a single theory tech. Default: 1

--UI.tech-progress

    Sets background color of progress bars in the tech tree. Default: (40,40,40,255)

--UI.tech-progress-background

    Sets bar color of progress bars in the tech tree. Default: (72,72,72,255)

--UI.text-color

    Sets UI text color. Default: (255,255,255,255)

--UI.tiny-fleet-button-minimum-zoom

    Sets minimum zoom level at which tiny fleet icons are shown on the galaxy map. At smaller zooms, no fleet icons are shown. Default: 0.75

--UI.title-font

    Sets UI title font resource file.

    Default: /usr/share/games/freeorion/default/DejaVuSans.ttf

--UI.title-font-size

    Sets UI title font size. Default: 12

--UI.tooltip-delay

    Sets UI tooltip popup delay, in ms. Default: 100

--UI.unowned-starlane-colour

    Sets default color to render starlanes. Default: (72,72,72,255)

--UI.unresearchable-tech

    Sets color of unresearchable techs in the tech tree. Default: (30,30,30,255)

--UI.unresearchable-tech-border

    Sets text and border color of unresearchable techs in the tech tree. Default: (86,86,86,255)

--UI.window-quickclose

    Close open windows such as fleet windows and the system-view side panel when you right-click on the main map. Default: 0

--UI.wnd-color

    Sets UI window background color. Default: (35,35,35,240)

--UI.wnd-inner-border-color

    Sets UI window inner border color. Default: (192,192,192,255)

--UI.wnd-outer-border-color

    Sets UI window outer border color. Default: (64,64,64,255)

--app-height

    Sets vertical app resolution in fullscreen mode. Default: 768

--app-height-windowed

    Sets vertical app resolution in windowed mode. Default: 768

--app-width

    Sets horizontal app resolution in fullscreen mode. Default: 1024

--app-width-windowed

    Sets horizontal app resolution in windowed mode. Default: 1024

--auto-advance-first-turn

    Hits the "Turn" button automatically on the first turn; useful for debugging, especially when used with --quickstart.

--autosave.limit

    Sets the maximum number of autosave files to keep. Default: 10

--autosave.multiplayer

    If true, autosaves will occur during multiplayer games. Default: 0

--autosave.single-player

    If true, autosaves will occur during single-player games. Default: 1

--autosave.turns

    Sets the number of turns between autosaves. Default: 1

--checked-gl-version

    Stores whether the OpenGL version of this system has been checked. If false, several rendering options may be altered depending on the GL version, after which, this option will be set to true. Default: 0

-c, --color-depth

    Sets screen color depth, in bits per pixel. Default: 32

--combat.enable-glow

    Toggles glow effects on and off. Default: 1

--combat.enable-lens-flare

    Toggles lens flares on and off. Default: 1

--combat.enable-skybox

    Toggles background skybox on and off. Default: 1

--combat.filled-selection

    Uses a filled-in effect, as opposed to an outline effect, on selected objects. Default: 0

--external-server-address

    Address to connect to in external server mode. If used, this client becomes the manager of the game. Default: localhost

--force-external-server

    Force the client not to start a server, even when hosting a game on localhost, playing single player, etc.

-f, --fullscreen

    Start the game in fullscreen.

-g, --generate-config-xml

    Uses default settings, settings from any existing config.xml file, and settings given on the command line to generate a config.xml file. This will overwrite the current config.xml file, if it exists.

-h, --help

    Print this help message.

--limit-fps

    Toggles FPS limiting on or off. Limit is set with Max FPS option. Default: 1

--load

    Loads the specified single-player save game. Default:

--log-level

    Sets the level at or above which log messages will be output (levels in order of decreasing verbosity: DEBUG, INFO, NOTICE, WARN, ERROR, CRIT, ALERT, FATAL, EMERG) Default: DEBUG

--max-fps

    Toggles FPS limit, if enabled. Limiting is toggled with Limit FPS. Default: 60

--multiplayersetup.host-address

    Address to connect to when joining a multiplayer game. Default: localhost

--multiplayersetup.player-name

    Player name to use when hosting or joining a multiplayer game. Default:

-q, --quickstart

    Starts a new quick-start game, bypassing the main menu.

--reset-fullscreen-size

    Stores whether to reset the stored fullscreen resolution. If false, the stored values are used, but if true, the values are reset to the max the rendering system supports. Default: 1

--resource-dir

    Sets the root directory for the game resource files (game content and data files). Default: /usr/share/games/freeorion/default

-S, --save-dir

    The directory in which saved games are saved and from which they are loaded. Default: ~/.freeorion/save

--show-fps

    Toggles FPS display on or off. Default: 0

--stringtable-filename

    Sets the language-specific string table filename. Default: /usr/share/games/freeorion/default/eng_stringtable.txt

--tech-demo

    Try out the 3D combat tech demo.

--test-3d-combat

    Test 3D combat resolution.

--verbose-logging

    Toggles verbose logging of universe contents and effect evaluation. Default: 0

--verbose-sitrep

    Toggles inclusion of situation report messages with errors. Default: 0

--version-string

    Tracks the FreeOrion version for which config.xml was generated. Config.xml for different versions will be ignored.