XOREOS(6)

NAME
xoreos - reimplementation of BioWare's Aurora engine

SYNOPSIS
xoreos [options] [target]

DESCRIPTION
xoreos is an open source implementation of BioWare's Aurora engine and its derivatives, licensed under the terms of the GNU General Public License version 3 (or later). The goal is to have all games using this engine working in a portable manner.

The following games are valid targets for xoreos:
•   Neverwinter Nights
•   Neverwinter Nights 2
•   Knights of the Old Republic
•   Knights of the Old Republic II: The Sith Lords
•   Jade Empire
•   Sonic Chronicles: The Dark Brotherhood
•   The Witcher
•   Dragon Age: Origins
•   Dragon Age II

  Running xoreos
First, you need to fully install and/or copy the game you want to play with xoreos onto your hard disk. How you do this depends on the game, your operating system and where/how you have bought the game.

xoreos does not yet have a launcher GUI or anything like this. You need to start it from the command line. Run xoreos with the command line option - -help to get a help text about further command line options.

The quickest way to start a game in path /path/to/game/ would be to call:

    $ xoreos -p/path/to/game/

If you're on Windows and the path is, say, D:\Path\To\Game\, call:

    $ xoreos -pD:\Path\To\Game\

  Config file
In general, xoreos can read the configuration which game to run from either the command line, a config file or both. Additionally, when you first specify a new game on the command line, xoreos will add a related entry in the config file (creating it first, if necessary).

To accurately identify a specific instance of an installed game, xoreos uses the concept of a “target”. Each target has a separate section in the config file, and each of their options apply only to that target. The special target “xoreos” is a global section applying to all games, although the same option in a game target overrides the global option.

For example:

    [xoreos]
    width=1024
    height=768
    fullscreen=false
    [nwn]
    path=/home/drmccoy/games/nwn/
    fullscreen=true
    volume_music=0.500000
    volume_sfx=0.850000
    volume_voice=0.850000

You can then start the game with the target “nwn” with

    $ xoreos nwn

and xoreos will do the rest. This will start the game in the path /home/drmccoy/games/nwn/, running it in fullscreen at 1024×768.

As you can see with the volume options, xoreos also saves settings you made in the game' actual GUI into the target's section of the config file.

The place where xoreos expects the config file depends on your operating system:
•   On GNU/Linux, the place is $XDG_CONFIG_HOME/xoreos/xoreos.conf. XDG_CONFIG_HOME defaults to $HOME/.config/.
•   On Mac OS X, the place is $HOME/Library/Preferences/xoreos/xoreos.conf.
•   On Windows, xoreos.conf is in the subdirectory xoreos in either $APPDATA or $USERPROFILE, depending on your Windows version.

OPTIONS
- -help
    Show a help text and exit.
- -version
    Show version information and exit.
-c file
- -config=file
    Load the config from file file.
-p dir
- -path=dir
    Override the game path with dir.
-w size
- -width=size
    Set the window's width to size.
-h size
- -height=size
    Set the window's height to size.
-f bool
- -fullscreen=bool
    Switch fullscreen on/off.
-k bool
- -skipvideos=bool
    Disable videos on/off.
-v vol
- -volume=vol
    Set global volume to vol.
-m vol
- -volume_music=vol
    Set music volume to vol.
-s vol
- -volume_sfx=vol
    Set SFX volume to vol.
-o vol
- -volume_voice=vol
    Set voice volume to vol.
-i vol
- -volume_video=vol
    Set video volume to vol.
-q lang
- -lang=lang
    Set the game's language.
- -langtext=lang
    Set the game's text language.
- -langvoice=lang
    Set the game's voice language.
-d lvl
- -debuglevel=lvl
    Set the debug level to lvl.
- -debugchannel=chan
    Set the enabled debug channel(s) to chan.
- -listdebug
    List all available debug channels.
- -listlangs
    List all available languages for this target.
- -logfile=file
    Write all debug output into this file too.
- -nologfile=bool
    Don't write a log file.
- -consolelog=file
    Write all debug console output into this file too.
- -noconsolelog=bool
    Don't write a debug console log file.

file
    Absolute or relative path to a file.

dir Absolute or relative path to a directory.

size
    A positive integer.

bool
    “true”, “yes”, “y”, “on”, and “1” are true, everything else is false.

vol A double ranging from 0.0 (min) – 1.0 (max).

lang
    A language identifier. Full name, ISO 639-1 or ISO 639-2 language code; or IETF language tag with ISO 639-1 and ISO 3166-1 country code. Examples: en, de_de, hun, Czech, zh-tw, zh_cn, zh-cht, zh-chs.

lvl A positive integer.

chan
    A comma-separated list of debug channels. Use “All” to enable all debug channels.

Long-form command line option, like - -skipvideos, map directly to config options. Options given on the command line will override any options found in the config file for this session, but will not save back to that config file.

EXAMPLES
    $ xoreos -p/path/to/nwn/

xoreos will start the game in /path/to/nwn/. Should a target with this path not yet exist in the config file, xoreos will create one named “nwn”.

    $ xoreos -p/path/to/nwn/ foobar

xoreos will start the game in /path/to/nwn/. If a target “foobar” does not yet exist in the config file, xoreos will create it.

    $ xoreos nwn

xoreos will start the game specified by target “nwn”, which must exist in the config file already.

SEE ALSO
More information about the xoreos project can be found on its website: https://xoreos.org/ and its wiki: https://wiki.xoreos.org/.

AUTHORS
This program is part of the xoreos projects, and was written by the xoreos team. Please see the AUTHORS file for details.