Mercurial > fife-parpg

annotate doc/README @ 105:2241b0d5379e

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
use strings as grouping in generic renderer, easier for the clients...
author spq@33b003aa-7bff-0310-803a-e67f0ece8222
date Thu, 24 Jul 2008 13:20:39 +0000
parents e945a1f51e3c
children
rev   line source
0
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
1 == Introduction ==
55
e945a1f51e3c * Last minute adjustments: we should tell the users at least that it's the 2008.1 release :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 54
diff changeset
2 Welcome to the FIFE 2008.1 README. This snapshot is based on SVN revision 2511.
53
1bcf91b6a1ee * Release README (list of changes by jasoka)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 52
diff changeset
3
1bcf91b6a1ee * Release README (list of changes by jasoka)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 52
diff changeset
4 == Table of contents ==
1bcf91b6a1ee * Release README (list of changes by jasoka)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 52
diff changeset
5 1 Theme of this release
1bcf91b6a1ee * Release README (list of changes by jasoka)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 52
diff changeset
6 2 Important changes since the 2008.1 release
1bcf91b6a1ee * Release README (list of changes by jasoka)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 52
diff changeset
7 3 Features
1bcf91b6a1ee * Release README (list of changes by jasoka)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 52
diff changeset
8 4 Building & running FIFE
1bcf91b6a1ee * Release README (list of changes by jasoka)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 52
diff changeset
9 4.1 General notes
1bcf91b6a1ee * Release README (list of changes by jasoka)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 52
diff changeset
10 4.2 Linux
1bcf91b6a1ee * Release README (list of changes by jasoka)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 52
diff changeset
11 4.3 Mac
1bcf91b6a1ee * Release README (list of changes by jasoka)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 52
diff changeset
12 4.4 Win32
1bcf91b6a1ee * Release README (list of changes by jasoka)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 52
diff changeset
13 5 Configuration
1bcf91b6a1ee * Release README (list of changes by jasoka)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 52
diff changeset
14 6 Known issues
1bcf91b6a1ee * Release README (list of changes by jasoka)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 52
diff changeset
15 7 Feedback
1bcf91b6a1ee * Release README (list of changes by jasoka)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 52
diff changeset
16 8 Signature
1bcf91b6a1ee * Release README (list of changes by jasoka)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 52
diff changeset
17
0
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
18 == Theme of this release ==
52
ab8b11adfb70 * Fixing code::blocks support for win32 (thanks to jasoka)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 51
diff changeset
19 For the 2008.1 release we decided to stick to the tropical island concept and called our example game "Rio de hola".
0
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
20
53
1bcf91b6a1ee * Release README (list of changes by jasoka)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 52
diff changeset
21 Caution: this release is still lacking a lot of polish, especially the "Rio de hola" game that ships with it. It lacks almost any form of gameplay but there is a reason why we decided to ship the release in its current form nevertheless. We planned to release future FIFE milestones under the LGPL to offer a less "restrictive" license to possible FIFE users (we know that the term "restrictive" is just our personal point of view).
0
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
22
53
1bcf91b6a1ee * Release README (list of changes by jasoka)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 52
diff changeset
23 We had to clear up the legal situation first and fortunately the software freedom law center (http://www.softwarefreedom.org/) helped us with the transition. The agreement of all developers who contributed code that was still used in FIFE was needed and because over three dozens of people contributed code to the project, this took us a lot of time. We were not able to reach all of them so we decided to either remove or rewrite the code of the contributors who didn't reply to our license switch proposal mails (from scratch).
0
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
24
52
ab8b11adfb70 * Fixing code::blocks support for win32 (thanks to jasoka)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 51
diff changeset
25 We were able to replace the last parts of the problematic code today so now FIFE is officially LGPL'ed software. We're glad that we were able to make this step after it took us so long and we think that the new license alone is worth a release. Therefore we're proud to finally present the first FIFE release that is published under LGPL 2.1 or newer (your choice).
0
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
26
51
191654cf9855 * Fixed code::blocks unittest support; thanks to alexv for reporting
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 0
diff changeset
27 Engine and the editor tool made _huge_ steps forward since the last release about 5 months ago. Therefore we decided to release the current status as stable release although it offers not many new aspects on the content side and the content that is in place is very likely to change with the 2008.2 release.
191654cf9855 * Fixed code::blocks unittest support; thanks to alexv for reporting
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 0
diff changeset
28
191654cf9855 * Fixed code::blocks unittest support; thanks to alexv for reporting
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 0
diff changeset
29 The milestone itself seems to be a very important step into the right direction. You can build your own maps now with the help of the editor tool. Furthermore a basic application structure is in place that should give you an idea how can create your own FIFE-based game; this release is stable enough to start working on your game now :-)
0
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
30
51
191654cf9855 * Fixed code::blocks unittest support; thanks to alexv for reporting
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 0
diff changeset
31 == Important changes since the 2008.0 release ==
53
1bcf91b6a1ee * Release README (list of changes by jasoka)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 52
diff changeset
32 === Model improvements & simplifications ===
1bcf91b6a1ee * Release README (list of changes by jasoka)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 52
diff changeset
33 * Elevations removed (Fallout legacy).
1bcf91b6a1ee * Release README (list of changes by jasoka)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 52
diff changeset
34 * Support for namespaces:
1bcf91b6a1ee * Release README (list of changes by jasoka)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 52
diff changeset
35 * New resource infrastructure migrated into whole engine. This enables:
1bcf91b6a1ee * Release README (list of changes by jasoka)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 52
diff changeset
36 * uniform pooling for all resources that need to be pooled.
1bcf91b6a1ee * Release README (list of changes by jasoka)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 52
diff changeset
37 * uniform loading for all resources (model stuff, images, sounds...).
1bcf91b6a1ee * Release README (list of changes by jasoka)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 52
diff changeset
38 * uniform saving for resources which support saving (model stuff).
1bcf91b6a1ee * Release README (list of changes by jasoka)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 52
diff changeset
39 * Datasets are now stored in a flat list in model instead of dataset hierarchy.
1bcf91b6a1ee * Release README (list of changes by jasoka)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 52
diff changeset
40 * Changes in model are now bookkeeped. Observer interfaces provided for change listeners.
1bcf91b6a1ee * Release README (list of changes by jasoka)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 52
diff changeset
41 * This enables e.g. reacting only to changes instead of polling on every round.
1bcf91b6a1ee * Release README (list of changes by jasoka)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 52
diff changeset
42 * Also critical enabler for triggers.
1bcf91b6a1ee * Release README (list of changes by jasoka)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 52
diff changeset
43 * Instances now support initial rotation value.
1bcf91b6a1ee * Release README (list of changes by jasoka)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 52
diff changeset
44 * Objects support default actions.
1bcf91b6a1ee * Release README (list of changes by jasoka)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 52
diff changeset
45 * Further model cleanup.
1bcf91b6a1ee * Release README (list of changes by jasoka)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 52
diff changeset
46
1bcf91b6a1ee * Release README (list of changes by jasoka)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 52
diff changeset
47 === XML format changes ===
1bcf91b6a1ee * Release README (list of changes by jasoka)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 52
diff changeset
48 * All resources are now defined with principle 1 file / 1 resource.
1bcf91b6a1ee * Release README (list of changes by jasoka)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 52
diff changeset
49 * Importing of objects can now be done also based on directories where they are contained.
1bcf91b6a1ee * Release README (list of changes by jasoka)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 52
diff changeset
50 * Relative paths are now used instead of absolute ones.
1bcf91b6a1ee * Release README (list of changes by jasoka)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 52
diff changeset
51
1bcf91b6a1ee * Release README (list of changes by jasoka)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 52
diff changeset
52 === Loaders ===
1bcf91b6a1ee * Release README (list of changes by jasoka)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 52
diff changeset
53 * All loading happens now from python (tinyxml dependency removed).
1bcf91b6a1ee * Release README (list of changes by jasoka)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 52
diff changeset
54 * Improved error reporting.
1bcf91b6a1ee * Release README (list of changes by jasoka)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 52
diff changeset
55
1bcf91b6a1ee * Release README (list of changes by jasoka)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 52
diff changeset
56 === Editor ===
1bcf91b6a1ee * Release README (list of changes by jasoka)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 52
diff changeset
57 * Possibility to move instances on map.
1bcf91b6a1ee * Release README (list of changes by jasoka)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 52
diff changeset
58 * Possibility to rotate instances on map.
1bcf91b6a1ee * Release README (list of changes by jasoka)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 52
diff changeset
59 * Possibility to zoom the map (OpenGL mode only).
1bcf91b6a1ee * Release README (list of changes by jasoka)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 52
diff changeset
60 * Painting with currently selected instance (e.g. large ground areas).
1bcf91b6a1ee * Release README (list of changes by jasoka)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 52
diff changeset
61 * Importing of multiple objects based on given directory.
1bcf91b6a1ee * Release README (list of changes by jasoka)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 52
diff changeset
62 * Initial map creation wizard (still work in progress).
1bcf91b6a1ee * Release README (list of changes by jasoka)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 52
diff changeset
63
1bcf91b6a1ee * Release README (list of changes by jasoka)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 52
diff changeset
64 === Rio de hola game ===
1bcf91b6a1ee * Release README (list of changes by jasoka)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 52
diff changeset
65 * More assets:
1bcf91b6a1ee * Release README (list of changes by jasoka)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 52
diff changeset
66 * Graphics, sounds, music...
1bcf91b6a1ee * Release README (list of changes by jasoka)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 52
diff changeset
67 * Two new maps matching the storyline.
1bcf91b6a1ee * Release README (list of changes by jasoka)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 52
diff changeset
68 * Rio de hola now conforms to package structure: http://wiki.fifengine.de/Fife_Package_Specification
1bcf91b6a1ee * Release README (list of changes by jasoka)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 52
diff changeset
69 * Popup menu integration, demonstration of actions (kick, talk).
1bcf91b6a1ee * Release README (list of changes by jasoka)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 52
diff changeset
70
1bcf91b6a1ee * Release README (list of changes by jasoka)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 52
diff changeset
71 === Pychan improvements ===
1bcf91b6a1ee * Release README (list of changes by jasoka)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 52
diff changeset
72 * Hiding of scrollbars.
1bcf91b6a1ee * Release README (list of changes by jasoka)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 52
diff changeset
73 * Text wrapping.
1bcf91b6a1ee * Release README (list of changes by jasoka)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 52
diff changeset
74 * A lot of smaller improvements.
1bcf91b6a1ee * Release README (list of changes by jasoka)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 52
diff changeset
75
1bcf91b6a1ee * Release README (list of changes by jasoka)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 52
diff changeset
76 === Functionality ===
1bcf91b6a1ee * Release README (list of changes by jasoka)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 52
diff changeset
77 * Pixel perfect instance picking (taking transparency into account).
1bcf91b6a1ee * Release README (list of changes by jasoka)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 52
diff changeset
78 * Ability to get list of instances from given screen rectangle.
1bcf91b6a1ee * Release README (list of changes by jasoka)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 52
diff changeset
79 * Distance calculations made easy, exposed to scripts.
1bcf91b6a1ee * Release README (list of changes by jasoka)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 52
diff changeset
80 * Instance outlining.
1bcf91b6a1ee * Release README (list of changes by jasoka)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 52
diff changeset
81 * Instance coloring.
1bcf91b6a1ee * Release README (list of changes by jasoka)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 52
diff changeset
82 * Screenshots are now saved in png format (instead of bmp).
1bcf91b6a1ee * Release README (list of changes by jasoka)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 52
diff changeset
83 * Stereo sound support in linux (introduced with the help of openal-soft).
1bcf91b6a1ee * Release README (list of changes by jasoka)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 52
diff changeset
84
1bcf91b6a1ee * Release README (list of changes by jasoka)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 52
diff changeset
85 === Video / view improvements ===
1bcf91b6a1ee * Release README (list of changes by jasoka)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 52
diff changeset
86 * Both renderbackend and separate images can now render graphical primitives (e.g. lines, dots..).
1bcf91b6a1ee * Release README (list of changes by jasoka)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 52
diff changeset
87 * Each camera now has separate set of renderers. Allows truly adjusting cameras independently.
1bcf91b6a1ee * Release README (list of changes by jasoka)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 52
diff changeset
88 * Zooming capability (currently properly supported only by OpenGL backend).
1bcf91b6a1ee * Release README (list of changes by jasoka)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 52
diff changeset
89 * Support for drag cursor definitions.
1bcf91b6a1ee * Release README (list of changes by jasoka)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 52
diff changeset
90 * OpenGL graphics chunking size is now definable in settings. Should help e.g. with large backgrounds.
1bcf91b6a1ee * Release README (list of changes by jasoka)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 52
diff changeset
91 * GenericRenderer adding customised rendering capabilities for scripts.
1bcf91b6a1ee * Release README (list of changes by jasoka)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 52
diff changeset
92
1bcf91b6a1ee * Release README (list of changes by jasoka)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 52
diff changeset
93 === Misc. changes ===
1bcf91b6a1ee * Release README (list of changes by jasoka)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 52
diff changeset
94 * Initial package structure defined for FIFE clients.
1bcf91b6a1ee * Release README (list of changes by jasoka)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 52
diff changeset
95 * Updated guichan to the latest release 0.8.1.
1bcf91b6a1ee * Release README (list of changes by jasoka)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 52
diff changeset
96 * Usage of unittest++ instead of boost unittests.
1bcf91b6a1ee * Release README (list of changes by jasoka)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 52
diff changeset
97 * Lots of bug fixes.
51
191654cf9855 * Fixed code::blocks unittest support; thanks to alexv for reporting
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 0
diff changeset
98
191654cf9855 * Fixed code::blocks unittest support; thanks to alexv for reporting
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 0
diff changeset
99 === Non-code related changes ===
54
fa98d27d0036 * Last minute README corrections, ready for tagging
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 53
diff changeset
100 * Switch from GPL 2.0 to LGPL 2.1 (or newer).
0
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
101
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
102 == Features ==
54
fa98d27d0036 * Last minute README corrections, ready for tagging
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 53
diff changeset
103 A complete list of the features that FIFE offers can be found at the project wiki:
fa98d27d0036 * Last minute README corrections, ready for tagging
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 53
diff changeset
104 * http://wiki.fifengine.de/index.php?title=Engine_features
0
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
105
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
106 == License ==
54
fa98d27d0036 * Last minute README corrections, ready for tagging
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 53
diff changeset
107 The source code (*.cpp, *.h & *.py) is licensed under LGPL 2.1 or newer:
fa98d27d0036 * Last minute README corrections, ready for tagging
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 53
diff changeset
108 * http://www.gnu.org/licenses/lgpl-2.1.html
0
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
109
51
191654cf9855 * Fixed code::blocks unittest support; thanks to alexv for reporting
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 0
diff changeset
110 Content was taken from a lot a lot of different 3rd party sources. Therefore each client directory comes with a separate LICENSE file that states the origin of the content, the author and the actual license it was published under.
0
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
111
53
1bcf91b6a1ee * Release README (list of changes by jasoka)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 52
diff changeset
112 == Building & running FIFE ==
0
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
113 === Dependencies ===
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
114 A list of all dependencies (including accurate version numbers) that you'll need to obtain to build FIFE on your platform can be found at the project wiki:
54
fa98d27d0036 * Last minute README corrections, ready for tagging
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 53
diff changeset
115 * http://wiki.fifengine.de/index.php?title=Build_dependencies
0
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
116
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
117 === General notes ===
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
118 FIFE utilizes the SCons (http://www.scons.org) build system. Here is a quick list of scons commands that can be important for building FIFE on your platform:
54
fa98d27d0036 * Last minute README corrections, ready for tagging
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 53
diff changeset
119 * 'scons ext=1' will build specific FIFE dependencies from source that usually don't reside in the most important Linux package managers.
fa98d27d0036 * Last minute README corrections, ready for tagging
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 53
diff changeset
120 * 'scons -h' will list additional compile options.
fa98d27d0036 * Last minute README corrections, ready for tagging
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 53
diff changeset
121 * 'scons' will build FIFE.
fa98d27d0036 * Last minute README corrections, ready for tagging
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 53
diff changeset
122 * 'scons tests=1' will build FIFE and the unittests (needed for test_fife.py).
fa98d27d0036 * Last minute README corrections, ready for tagging
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 53
diff changeset
123 * 'scons -c' clears any compiled objects (= scons equivalent of 'make clean').
0
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
124
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
125 Platform specific details how to build FIFE can be found down below.
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
126
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
127 === Linux ===
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
128 Detailed information how to build FIFE on Linux-based distributions can be found at the project wiki:
54
fa98d27d0036 * Last minute README corrections, ready for tagging
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 53
diff changeset
129 * http://wiki.fifengine.de/index.php?title=Building:Linux:SCons
0
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
130
52
ab8b11adfb70 * Fixing code::blocks support for win32 (thanks to jasoka)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 51
diff changeset
131 After FIFE has been built successfully move into the <FIFE>/clients/rio_de_hola directory and run: python run.py
0
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
132
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
133 === Mac ===
52
ab8b11adfb70 * Fixing code::blocks support for win32 (thanks to jasoka)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 51
diff changeset
134 Detailed information how to build FIFE on Macintosh systems can be found at the project wiki:
54
fa98d27d0036 * Last minute README corrections, ready for tagging
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 53
diff changeset
135 * http://wiki.fifengine.de/index.php?title=Building:Mac:Scons
0
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
136
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
137 Caution: the Mac compile guide is currently heavily outdated! We would like to improve this situation but we're lacking a Mac maintainer who could take care of that. In case you're interested in the position feel free to get in contact with our developers on the project's IRC channel:
54
fa98d27d0036 * Last minute README corrections, ready for tagging
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 53
diff changeset
138 * http://wiki.fifengine.de/index.php?title=IRC
0
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
139
52
ab8b11adfb70 * Fixing code::blocks support for win32 (thanks to jasoka)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 51
diff changeset
140 In case you manage to build FIFE on your Mac system you can move into the <FIFE>/clients/rio_de_hola directory and run: python run.py
0
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
141
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
142 === Win32 ===
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
143 The Win32 package ships with precompiled binaries. Simply unpack the package to location of your choice. After that you'll need to install ActivePython 2.5 to run the techdemo:
54
fa98d27d0036 * Last minute README corrections, ready for tagging
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 53
diff changeset
144 * http://downloads.activestate.com/ActivePython/windows/2.5/ActivePython-2.5.2.2-win32-x86.msi (for 32bit Windows systems)
fa98d27d0036 * Last minute README corrections, ready for tagging
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 53
diff changeset
145 * http://downloads.activestate.com/ActivePython/windows/2.5/ActivePython-2.5.2.2-win64-x64-nopywin32.msi (for 64bit Windows systems)
0
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
146
52
ab8b11adfb70 * Fixing code::blocks support for win32 (thanks to jasoka)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 51
diff changeset
147 Move into the <FIFE>\clients\rio_de_hola directory and start the run.py script. You can simply double-click with your mouse on it. It should be automatically associated with the Python interpreter after installing ActivePython.
0
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
148
52
ab8b11adfb70 * Fixing code::blocks support for win32 (thanks to jasoka)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 51
diff changeset
149 The editor tool can be found within the <FIFE>\clients\editor directory. You can launch it by running run.py.
0
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
150
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
151 Last but not least there is an example client residing in <FIFE>\clients\pychan_demo that shows how the pychan GUI library works. Start the GUI demo application by running pychan_test.py.
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
152
53
1bcf91b6a1ee * Release README (list of changes by jasoka)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 52
diff changeset
153 == Configuration ==
52
ab8b11adfb70 * Fixing code::blocks support for win32 (thanks to jasoka)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 51
diff changeset
154 The engine utilizes special settings files for configuring FIFE. This file is called settings.py and resides in the same directory as the run.py scripts. You can customize FIFE by editing this file.
0
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
155
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
156 == Known issues ==
54
fa98d27d0036 * Last minute README corrections, ready for tagging
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 53
diff changeset
157 * All included maps are still really early work in progress versions that lack proper blocking. Furthermore a lot of planned map objects are missing because we're still searching for 3d artists who could help us with the creation of those.
fa98d27d0036 * Last minute README corrections, ready for tagging
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 53
diff changeset
158 * Despite the Rio de hola client is labeled as a game, it does not feature any relevant kind of gameplay yet. We can hopefully improve this over the next releases. We released FIFE in its current form nevertheless because the license switch as well as the engine and editor improvements are huge steps forward in our opinion.
fa98d27d0036 * Last minute README corrections, ready for tagging
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 53
diff changeset
159 * Win32 users tend to suffer from problems with the OpenAL drivers. If you don't hear the background music playing while running Rio de hola, run oalinst.exe that ships with the Win32 package. This is the latest OpenAL driver for Win32.
fa98d27d0036 * Last minute README corrections, ready for tagging
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 53
diff changeset
160 * The unittests are broken on Win32 (if used in combination with scons & mingw). We plan to address this issue but we're lacking active Win32 developers to look into these kind of problems as the vast majority of the active developers are running Linux. If you would like to help out with Win32-related issues please contact us at our IRC channel: http://wiki.fifengine.de/index.php?title=IRC
0
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
161
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
162 == Feedback ==
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
163 We appreciate every kind of feedback concerning the release, the project in general and the bundled techdemo. Feedback is a great way to help us to improve FIFE. If you would like to get in contact with us and provide feedback you can either visit our IRC channel or our forums:
54
fa98d27d0036 * Last minute README corrections, ready for tagging
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 53
diff changeset
164 * http://wiki.fifengine.de/index.php?title=IRC
fa98d27d0036 * Last minute README corrections, ready for tagging
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 53
diff changeset
165 * http://forums.fifengine.de/index.php?board=5.0
0
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
166
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
167 == Signature ==
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
168 Have fun with the release and let us know what you think about it!
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
169 -- The FIFE team.
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
170
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
171 http://www.fifengine.de/
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
172
51
191654cf9855 * Fixed code::blocks unittest support; thanks to alexv for reporting
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 0
diff changeset
173 2008/07/13