cmake: also require vorbisfile.h and take extra care to include it
[gemrb.git] / README
blob8d3b7195536245ac81060257a6db7187d1ef15f8
1 Introduction
2 ------------
3 GemRB (Game Engine Made with preRendered Background) is a "port"
4 (actually a new implementation) of the original Infinity Engine (the one
5 of Baldur's Gate, Icewind Dale, Planescape: Torment, ...) to
6 Linux/Unix, MacOS X and Windows with some enhancements. Would you like to
7 create a game like Baldur's Gate?
9 It means that you either need some of the original game's data
10 somewhere on your harddisk, or you can try to use the data from the
11 Dragonlance Total Conversion project - see the link below.
13 The original game data has to be installed on a windows
14 partition and mounted to your Linux/Unix filesystem, installed on
15 windows and then copied to your filesystem, installed with WINE or 
16 extracted manually from the CDs using the tool `unshield'.
18 What little documentation exists is mostly in gemrb/docs/en/ and
19 subdirectories, the gemrb.6 man page and this file.
21 Supported platforms
22 -------------------
23 Supported (i.e. we got reports about successfully running GemRB) systems:
24 Linux x86, x86-64, ppc
25 FreeBSD x86
26 MS Windows (98, XP or Vista)
27 various Macintosh systems (even pre x86) also should work ...
28 some smart phones (Symbian, Android)
29 some consoles (OpenPandora, Dingoo)
30 some exotic OSes (ReactOS, SyllableOS, Haiku)
32 Requirements
33 ------------
34 See the INSTALL file.
36 Contacts
37 --------
38 Our homepage:
39 http://gemrb.sourceforge.net
41 Our project at sourceforge.net:
42 http://sourceforge.net/projects/gemrb
44 New GemRB forum (users):
45 http://forums.gibberlings3.net/index.php?showforum=91
47 IRC channel:
48 The best way to talk with us is by joining the #GemRB channel
49 on the FreeNode IRC network. There's somebody to talk with most of
50 the time.
53 Useful links
54 ------------
55 IESDP, documentation for the Infinity Engine file formats and more:
56 http://iesdp.gibberlings3.net/
58 Near Infinity, Java viewer and editor for data files of the original games:
59 http://www.idi.ntnu.no/~joh/ni/index.html
61 DLTCEP, MS Windows viewer and editor for data files of the original games:
62 http://forums.gibberlings3.net/index.php?showforum=137
64 Unshield, extractor for .CAB files created by InstallShield
65 http://synce.sourceforge.net/synce/unshield.php
67 Valgrind, a powerful developer tool to fix programmer errors (leaks, buffer overflows and all the like that happen)
68 http://valgrind.org/
70 SDL, Simple Directmedia Layer, the graphical library used for GemRB
71 http://www.libsdl.org/index.php
73 OpenAL, Cross-Platform 3D audio libraries, the sound library used for GemRB
74 http://openal.org/
76 WINE, Open Source implementation of the Windows API, useful for installing the games
77 http://www.winehq.org