[xoreos-devel] Start problems

[Sven Hesse]

Hej hej!

Yes, xoreos still has no user documentation at all.
It's one of the many TODOs, but given the very preliminary state, not
a high priority one.

But:
You don't strictly need one. If you read the help text (just start
xoreos without any arguments, or with --help or -h), you should be
able to grog how xoreos wants to be used. Specifically, if you
want to start the game from a directory /data/to/kotor, you start
xoreos with the argument -p /path/to/kotor. (*)

xoreos then creates a config file for you, giving that directory a
target name of "kotor". Depending on your OS, the config file is in
several places:
1) On GNU/Linux, it's $XDG_CONFIG_HOME/.xoreosrc ($XDG_CONFIG_HOME
   defaults to $HOME/.config/
2) On MacOS X, it's $HOME/Library/Preferences/xoreos\ Preferences
3) On Windows, it's xoreos.ini in either APPDATA, USERPROFILE or
   the current directory, depending on the Windows version

The format is a simple ini-style config file.
The "[xoreos]"-domain is for program-wide settings. All other domains
set up "targets" for specific games. For example:

[kotor]
path=/path/to/kotor

Sets up a "kotor" target. You can then just start xoreos with "kotor"
as the sole option and it starts the game in the config-specified
path.  All settings made in-game will be saved under that domain.
There's also a bit of logic to create a new target for a new path,
and for preserving comments (starting with "#" till the end of the
line).


(*) Thinking about it now, I guess the help text is quite ambigous.
    If you want to start a game that has no target yet, and want
    xoreos to create one for you, you omit the target. I.e., you
    just call xoreos with -p /path/, and no target.
    Probably would be better to a) Mark the target as optional in
    the help text and/or b) Let xoreos use a provided target name
    to create a new target.


I hope this makes it a bit clearer.


Cheers
	Sven
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 198 bytes
Desc: Digital signature
URL: <http://xoreos.org/pipermail/xoreos-devel/attachments/20120909/edef2bb2/attachment.pgp>