Skip to content


Subversion checkout URL

You can clone with
Download ZIP
A reimplementation of BioWare's Aurora engine (and derivatives). Pre-pre-alpha :P
C++ C Other
branch: master
Failed to load latest commit information.
build-aux BUILD: Use aux directory to store autogenerated files
cmake BUILD: Add scripts to parse all and build with CMake.
dists DOCS: Update copyright year to 2015
doc/doxygen DOCS: Remove the format specification
gitstamp BUILD: Separate build fields in the version with a .
glew GLEW: Upgrade to version 1.12.0
lua DOCS: Rename README.eos in Lua to README.xoreos
m4 BUILD: Add dependency on libxml2 (>= 2.9.1)
src DRAGONAGE2: Properly implement/fix player-type creature assembly
utf8cpp UTF8: Upgrade to version 2.3.4
.gitignore DISTS: Remove the convience symlink from the .gitignore
.travis.yml BUILD: Add dependency on libxml2 (>= 2.9.1) BUILD: Get the version for coverity_scan from the Makefile
.uncrustifyrc CLEANUP: Don't force all if branches to same brace style
AUTHORS DOCS: Credit cc9cii in the Contributors list
BUILDDEP BUILD: Add dependency on libxml2 (>= 2.9.1)
CMakeLists.txt BUILD: Add libxml2 dependency to the CMake build system DOCS: Update Code of Conduct to Contributor Covenant 1.1.0 DOCS: Add a Code of Conduct
COPYING ALL: Relicense eos from GPLv2+ to GPLv3+
ChangeLog DOCS: Update the ChangeLog a bit
Doxyfile DOCS: Remove/Change obsolete Doxygen configuration DOCS: Answer questions about Mass Effect and Witcher 2/3 in the FAQ BUILD: Add missing files to EXTRA_DIST and dist_doc_DATA
Makefile.common BUILD: Add dependency on libxml2 (>= 2.9.1)
NEWS Initial empty frame
README DOCS: Add a dummy README to shut up automake
README.dox DOCS: Change Doxygen author string to "The xoreos Team" DOCS: Update the a bit
TODO DOCS: The TODO moved to our wiki BUILD: Don't have call configure BUILD: Add dependency on libxml2 (>= 2.9.1)

xoreos README

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 engines working in a portable manner, starting from Neverwinter Nights and ending with Dragon Age II.


The following games are valid targets for xoreos:

Status Build Status Coverity Status

Currently, the "foundation" work of managing resources, reading many basic file formats, displaying graphics and playing sounds has been done. Most games show partial ingame graphics, such as the area geometry and objects, letting you fly around in a "spectator mode". No actual "normal" gameplay is implemented yet, though.

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

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

Compiling xoreos

Since we are not yet distributing binaries of xoreos, you will have to compile xoreos yourself. Please read the compiling xoreos page on our wiki for information on how to do this on various operating systems.

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" (without the quotes) 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:



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 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/.xoreosrc. $XDG_CONFIG_HOME defaults to $HOME/.config/
  • On Mac OS X, the place is $HOME/Library/Preferences/xoreos\ Preferences/.xoreosrc
  • On Windows, the file is called xoreos.ini and is in the subdirectory xoreos in either $APPDATA or $USERPROFILE, depending on your Windows version



To contact us, please either write to mailing list, or join our IRC channel #xoreos on Freenode.

Something went wrong with that request. Please try again.