Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
A reimplementation of BioWare's Aurora engine (and derivatives). Pre-pre-alpha :P
C++ C
branch: master
Failed to load latest commit information.
build-aux BUILD: Use aux directory to store autogenerated files
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.11.0
lua DOCS: Rename README.eos in Lua to README.xoreos
m4 BUILD: Update ax_pthread to serial 21
src NWN: Add Class selection in CharGen
utf8cpp JANITORIAL: Be more specific with the include directive
.gitignore DISTS: Remove the convience symlink from the .gitignore
.travis.yml BUILD: Disable coverity_scan test mode
.travis_coverity.sh BUILD: Get the version for coverity_scan from the Makefile
.uncrustifyrc CLEANUP: Don't force all if branches to same brace style
AUTHORS DOCS: Properly credit Beren Minor in the contributors list
BUILDDEP BUILD: Bump minimum Boost version to 1.48.0
CONTRIBUTING.md DOCS: Add a CONTRIBUTING file
COPYING ALL: Relicense eos from GPLv2+ to GPLv3+
ChangeLog DOCS: Update the ChangeLog
Doxyfile DOCS: Remove/Change obsolete Doxygen configuration
FAQ.md DOCS: Update the FAQ
Makefile.am BUILD: Also remove temporary Doxygen files in doxygen-clean
Makefile.common JANITORIAL: Be more specific with the include directive
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"
README.md DOCS: Syntax-highlight config example in README.md
TODO DOCS: The TODO moved to our wiki
autogen.sh BUILD: Don't have autogen.sh call configure
configure.ac GRAPHICS: Render queue and manager

README.md

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.

Games

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. Some games show a working menu or even partial ingame graphics and working scripts, but no actual "normal" gameplay is implemented yet.

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. Right now, the most pressing matter is a rewrite of the graphics stack. Please see the related blog post.

If you'd like to help, please feel free to contact us!

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:

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

Links

Contact

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.