Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
A reimplementation of BioWare's Aurora engine (and derivatives). Pre-pre-alpha :P
C++ C Other
Branch: master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
build-aux BUILD: Use aux directory to store autogenerated files
cmake BUILD: Add CMake modules for Windows and add MSVC specific settings
dists RELEASE: This is version 0.0.2
doc DOCS: Add a note about xoreos.conf encoding, with example
gitstamp BUILD: Fix the gitstamp dirty flag not correctly updating
glew GLEW: Upgrade to version 1.12.0
lua DOCS: Rename README.eos in Lua to README.xoreos
m4 BUILD: Use ZLIB_VERNUM to check for the correct zlib version
man DOCS: Add a man page for xoreos
src COMMON: Make ?: vs + operator precedence more clear in convertString()
utf8cpp UTF8: Upgrade to version 2.3.4
.gitignore DISTS: Add temporary CMake files to the .gitignore
.travis.yml BUILD: Roll back the conversion to the new Travis CI infrastructure
.travis_coverity.sh BUILD: Filter "unknown extended header" in tar, with set -e left on
.uncrustifyrc CLEANUP: Don't force all if branches to same brace style
AUTHORS BUILD: Remove the autoconf macros to check for GLU and GLUT
BUILDDEP.md DOCS: Move BUILDDEP to BUILDDEP.md; it is formatted as Markdown
CMakeLists.txt BUILD: Fix adding ".dirty" in CMake builds
CODE_OF_CONDUCT.md DOCS: Update the Code of Conduct to the Contributor Covenant 1.2.0
CONTRIBUTING.md DOCS: Add a Code of Conduct
COPYING ALL: Relicense eos from GPLv2+ to GPLv3+
ChangeLog DOCS: Start a ChangeLog entry for the next, future version
Doxyfile RELEASE: This is version 0.0.2
FAQ.md DOCS: Answer questions about Mass Effect and Witcher 2/3 in the FAQ
Makefile.am DOCS: Add a xoreos.conf.example file
Makefile.common BUILD: Add dependency on Boost.Locale
NEWS.md DOCS: Move NEWS to NEWS.md, since it is formatted as Markdown already
README.dox DOCS: Change Doxygen author string to "The xoreos Team"
README.md DOCS: Link to xoreos.conf.example in the README.md
TODO DOCS: The TODO moved to our wiki
autogen.sh BUILD: Don't have autogen.sh call configure
configure.ac RELEASE: This is version 0.0.2

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. All targeted games show partial ingame graphics, such as the area geometry and objects, letting you fly around in a "spectator mode". Some games show partial menus, 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 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 CONTRIBUTING.md 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:

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

For a more elaborate example with more in-depth explanations, please see xoreos.conf.example in the doc directory.

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.