GUIScript: Make Setup*Icons functions take a dict to get the callbacks from.
[gemrb.git] / README
blob1cc335c3cab8346c6eb6978e5f802f65b0a97832
1 G E M R B
2 *********
5 GemRB (Game Engine Made with preRendered Background) is a "port"
6 (actually a new implementation) of the original Infinity Engine (the one
7 of Baldur's Gate, Icewind Dale, Planescape: Torment, ...) to
8 Linux/Unix, MacOS X and Windows with some enhancements. Would you like to
9 create a game like Baldur's Gate?
11 It means that you either need some of the original game's data
12 somewhere on your harddisk, or you can try to use the data from the
13 Dragonlance Total Conversion project - see the link below.
15 The original game data has to be installed on a windows
16 partition and mounted to your Linux/Unix filesystem, installed on
17 windows and then copied to your filesystem, installed with WINE or 
18 extracted manually from the CDs using the tool `unshield'.
21 What little documentation exists is mostly in gemrb/docs/en/ and
22 subdirectories, the gemrb.6 man page and this file.
24 Supported (i.e. we got reports about successfully running GemRB) systems:
26 Linux x86, x86-64, ppc
27 FreeBSD x86
28 MS Windows (98, XP or Vista)
29 some Nokia N8x0 systems
30 various Macintosh systems (even pre x86) also should work ...
32 Requirements:
34 SDL 1.2
35 OpenAL 0.0.7 or above, (not required if you don't want sound)
36 Python 2.2 or above, with shared libs (binaries are compiled with 2.5!)
37 ZLib 1.2
38 Png 1.2 (optional)
40 If you compile from source, you will need the development packages!
42 Contacts
43 --------
45 Our homepage:
46 http://gemrb.sourceforge.net
48 Our project at sourceforge.net:
49 http://sourceforge.net/projects/gemrb
51 New GemRB forum (users):
52 http://forums.gibberlings3.net/index.php?showforum=91
54 IRC channel:
55 The best way to talk with us is by joining the #GemRB channel
56 on the FreeNode IRC network. There's somebody to talk with most of
57 the time.
60 Useful links
61 ------------
63 IESDP, documentation for the Infinity Engine file formats and more:
64 http://iesdp.gibberlings3.net/
66 Near Infinity, Java viewer and editor for data files of the original games:
67 http://www.idi.ntnu.no/~joh/ni/index.html
69 DLTCEP, MS Windows viewer and editor for data files of the original games:
70 http://forums.gibberlings3.net/index.php?showforum=137
72 Unshield, extractor for .CAB files created by InstallShield
73 http://synce.sourceforge.net/synce/unshield.php
75 Valgrind, a powerful developer tool to fix programmer errors (leaks, buffer overflows and all the like that happen)
76 http://valgrind.org/
78 SDL, Simple Directmedia Layer, the graphical library used for GemRB
79 http://www.libsdl.org/index.php
81 OpenAL, Cross-Platform 3D audio libraries, the sound library used for GemRB
82 http://openal.org/
84 WINE, Open Source implementation of the Windows API, useful for installing the games
85 http://www.winehq.org