[xoreos-devel] Want to help

[Sven Hesse]

Hi Jerome!

Sorry for the late reply; I've been quite busy lately.

On 2017-07-24 23:45:13 +0200, Bardot Jérôme wrote:
> I not have lot of time but i ready for working few hour by week.

xoreos is always in need of contributors, so we would be happy to have
you! :)

> First i want to read the wiki and the doc.

If you haven't already seen, the Developer Central page [1] in our
wiki is generally the best entry for how xoreos development works.

Next up, if you haven't already, check out the main repository from
GitHub [2] (an overview of our repositories can be found on the Git
page on our wiki [3]) and compile the code. Some pointers on how to
compile xoreos can be found on the Compiling xoreos page [4], but it
is still missing in-depth documentation on how to do this on various
systems and configurations. In short, due to list of library
dependencies, setting up xoreos will be easier when you can just pull
those libraries from a package repository, be it from a Linux
distribution, Homebrew (or equivalent) on macOS or MSYS2 on Windows.

That would be the first step, to get the code, compile and run it.

Of course, you also need the data files of one of the BioWare games.
The Games page [5] on the website shows a few places where the games
can be legally obtained (Note: we do not support piracy!). Install the
game(s) you're interested in (for Windows-only games, you can use Wine
on Linux and macOS) and point xoreos to the installation directory.

Play around with what works already. Note what doesn't work.

As for the organization of the code itself, the directory structure
should be fairly obvious:

- src/version/: code to insert a git version string into xoreos
- src/common/: common low-level utility code and classed
- src/aurora/: general BioWare-engine file readers
- src/graphics/: general graphics (SDL and OpenGL) code
- src/graphics/aurora/: BioWare-engine graphics file readers
- src/graphics/images/: image file reader
- src/sound/: sound subsystem, playing of sound files
- src/sound/decoders/: sound file readers
- src/events/: events subsystem, i.e. keyboard/mouse input mostly
- src/video/: video (movies, cutscenes) decoding and playing
- src/engines/: specialized code for the individual games

Likewise, we have a xoreos-tools repository that contains various
tools that might be useful for modding and/or exploring the games.
Most of them are a byproduct of xoreos proper. And there's also a
phaethon repository which contains a partially working resource
explorer (work is currently being done to convert Phaethon from
wxWidgets to Qt).

On our wiki, you can also find a TODO page [6]. This list is of course
not exhaustive; there is a lot to be done in xoreos.
And, sadly, a lot of these tasks are quite big, involved. There isn't
really a beginner-level entry task available. Some tasks are being
worked on, too, so please drop by on Freenode IRC (#xoreos) if you
want to work on something, to coordinate things.

If you have any questions, please feel free to ask; I'll be happy to
answer them.


[1] https://wiki.xoreos.org/index.php?title=Developer_Central
[2] https://github.com/xoreos/xoreos
[3] https://wiki.xoreos.org/index.php?title=Git
[4] https://wiki.xoreos.org/index.php?title=Compiling_xoreos
[5] https://xoreos.org/games/index.html
[6] https://wiki.xoreos.org/index.php?title=TODO


Cheers
Sven
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 833 bytes
Desc: not available
URL: <http://xoreos.org/pipermail/xoreos-devel/attachments/20170801/89ff1485/attachment.asc>