Repository files navigation

xoreos is an open source implementation of BioWare's Aurora engine and itsderivatives, licensed under the terms of theGNU General Public Licenseversion 3 (or later). The goal isto have all games using this engines working in a portable manner, startingfrom Neverwinter Nights and ending with Dragon Age II.

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

Currently, the "foundation" work of managing resources, reading many basicfile formats, displaying graphics and playing sounds has been done. Alltargeted games show partial ingame graphics, such as the area geometry andobjects, letting you fly around in a "spectator mode". Some games show partialmenus, and something resembling a starting point for a script system is there.

No actual "normal" gameplay is implemented yet, though.

For further information about the status of specific games, please visitour wiki.

Note: We are always looking for people to join our efforts in reimplementingthose games. If you'd like to help, feel free to contact us!Please also read over ourCONTRIBUTING.md for someguidelines. Thanks.

You can get xoreos in multiple ways:

You can download an archive with a binary of the latest release from ourdownloads page. This includesbinaries for Microsoft Windows, Mac OS X and GNU/Linux, as well as packagesfor various GNU/Linux distributions. All of them are available for both 32-and 64-bit x86 architectures.

Or, if you're running Arch Linux, you can install xoreos directly from theAUR.

Or, if you're running Gentoo Linux, you can install xoreos directly from ouroverlay.

Lastly, you can compile xoreos yourself; either from a release source package,found on ourdownloads page, or afreshrepository checkout. For detailson how to compile xoreos on various operating system, please read theCompiling xoreospage on our wiki.

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

xoreos does not yet have a launcher GUI or anything like this. You need tostart it from the command line. Run xoreos with the command line option"--help" (without the quotes) to get a help text about further command lineoptions.

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\\

For a more in-depth documentation on how to run xoreos, please also read theRunning xoreospage on our wiki.

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

To accurately identify a specific instance of an installed game, xoreos uses theconcept 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 optionin a game target overrides the global option.

For example:

[xoreos]width=1024height=768fullscreen=false[nwn]path=/home/drmccoy/games/nwn/fullscreen=truevolume_music=0.500000volume_sfx=0.850000volume_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 1024x768.

As you can see with the volume options, xoreos also saves settings you made inthe 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 $APPDATAor $USERPROFILE, depending on your Windows version

For a more elaborate example with more in-depth explanations, please seexoreos.conf.example in the doc directory, or theRunning xoreospage on our wiki.

• xoreos website
• xoreos wiki
• Screenshots
• Main source repository
• All xoreos repositories
• Doxygen documentation

To contact us, please either write tomailing list,or join our IRC channel #xoreos onLibera IRC.