Mercurial > fife-parpg

comparison doc/README @ 54:fa98d27d0036

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
* Last minute README corrections, ready for tagging
author mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
date Sun, 13 Jul 2008 17:43:15 +0000
parents 1bcf91b6a1ee
children e945a1f51e3c
comparison
equal deleted inserted replaced
53:1bcf91b6a1ee 54:fa98d27d0036
1 == Introduction == 1 == Introduction ==
2 Welcome to the FIFE 2008.1 README. This snapshot is based on SVN revision 2509. 2 Welcome to the FIFE 2008.1 README. This snapshot is based on SVN revision 2510.
3 3
4 == Table of contents == 4 == Table of contents ==
5 1 Theme of this release 5 1 Theme of this release
6 2 Important changes since the 2008.1 release 6 2 Important changes since the 2008.1 release
7 3 Features 7 3 Features
12 4.4 Win32 12 4.4 Win32
13 5 Configuration 13 5 Configuration
14 6 Known issues 14 6 Known issues
15 7 Feedback 15 7 Feedback
16 8 Signature 16 8 Signature
17
18 17
19 == Theme of this release == 18 == Theme of this release ==
20 For the 2008.1 release we decided to stick to the tropical island concept and called our example game "Rio de hola". 19 For the 2008.1 release we decided to stick to the tropical island concept and called our example game "Rio de hola".
21 20
22 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). 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).
96 * Updated guichan to the latest release 0.8.1. 95 * Updated guichan to the latest release 0.8.1.
97 * Usage of unittest++ instead of boost unittests. 96 * Usage of unittest++ instead of boost unittests.
98 * Lots of bug fixes. 97 * Lots of bug fixes.
99 98
100 === Non-code related changes === 99 === Non-code related changes ===
101 * Switch from GPL 2.0 to LGPL 2.1 (or newer). 100 * Switch from GPL 2.0 to LGPL 2.1 (or newer).
102 101
103 == Features == 102 == Features ==
104 * A complete list of the features that FIFE offers can be found at the project wiki: http://wiki.fifengine.de/index.php?title=Engine_features 103 A complete list of the features that FIFE offers can be found at the project wiki:
104 * http://wiki.fifengine.de/index.php?title=Engine_features
105 105
106 == License == 106 == License ==
107 The source code (*.cpp, *.h & *.py) is licensed under LGPL 2.1 or newer: http://www.gnu.org/licenses/lgpl-2.1.html 107 The source code (*.cpp, *.h & *.py) is licensed under LGPL 2.1 or newer:
108 * http://www.gnu.org/licenses/lgpl-2.1.html
108 109
109 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. 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.
110 111
111 == Building & running FIFE == 112 == Building & running FIFE ==
112 === Dependencies === 113 === Dependencies ===
113 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: 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:
114 http://wiki.fifengine.de/index.php?title=Build_dependencies 115 * http://wiki.fifengine.de/index.php?title=Build_dependencies
115 116
116 === General notes === 117 === General notes ===
117 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: 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:
118 * 'scons ext=1' will build specific FIFE dependencies from source that usually don't reside in the most important Linux package managers. 119 * 'scons ext=1' will build specific FIFE dependencies from source that usually don't reside in the most important Linux package managers.
119 * 'scons -h' will list additional compile options. 120 * 'scons -h' will list additional compile options.
120 * 'scons' will build FIFE. 121 * 'scons' will build FIFE.
121 * 'scons tests=1' will build FIFE and the unittests (needed for test_fife.py). 122 * 'scons tests=1' will build FIFE and the unittests (needed for test_fife.py).
122 * 'scons -c' clears any compiled objects (= scons equivalent of 'make clean'). 123 * 'scons -c' clears any compiled objects (= scons equivalent of 'make clean').
123 124
124 Platform specific details how to build FIFE can be found down below. 125 Platform specific details how to build FIFE can be found down below.
125 126
126 === Linux === 127 === Linux ===
127 Detailed information how to build FIFE on Linux-based distributions can be found at the project wiki: 128 Detailed information how to build FIFE on Linux-based distributions can be found at the project wiki:
128 http://wiki.fifengine.de/index.php?title=Building:Linux:SCons 129 * http://wiki.fifengine.de/index.php?title=Building:Linux:SCons
129 130
130 After FIFE has been built successfully move into the <FIFE>/clients/rio_de_hola directory and run: python run.py 131 After FIFE has been built successfully move into the <FIFE>/clients/rio_de_hola directory and run: python run.py
131 132
132 === Mac === 133 === Mac ===
133 Detailed information how to build FIFE on Macintosh systems can be found at the project wiki: 134 Detailed information how to build FIFE on Macintosh systems can be found at the project wiki:
134 http://wiki.fifengine.de/index.php?title=Building:Mac:Scons 135 * http://wiki.fifengine.de/index.php?title=Building:Mac:Scons
135 136
136 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: 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:
137 http://wiki.fifengine.de/index.php?title=IRC 138 * http://wiki.fifengine.de/index.php?title=IRC
138 139
139 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 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
140 141
141 === Win32 === 142 === Win32 ===
142 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: 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:
143 http://downloads.activestate.com/ActivePython/windows/2.5/ActivePython-2.5.2.2-win32-x86.msi (for 32bit Windows systems) 144 * http://downloads.activestate.com/ActivePython/windows/2.5/ActivePython-2.5.2.2-win32-x86.msi (for 32bit Windows systems)
144 http://downloads.activestate.com/ActivePython/windows/2.5/ActivePython-2.5.2.2-win64-x64-nopywin32.msi (for 64bit Windows systems) 145 * http://downloads.activestate.com/ActivePython/windows/2.5/ActivePython-2.5.2.2-win64-x64-nopywin32.msi (for 64bit Windows systems)
145 146
146 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. 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.
147 148
148 The editor tool can be found within the <FIFE>\clients\editor directory. You can launch it by running run.py. 149 The editor tool can be found within the <FIFE>\clients\editor directory. You can launch it by running run.py.
149 150
151 152
152 == Configuration == 153 == Configuration ==
153 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. 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.
154 155
155 == Known issues == 156 == Known issues ==
156 * 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. 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.
157 * 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. 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.
158 * 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. 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.
159 * 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: 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
160 http://wiki.fifengine.de/index.php?title=IRC
161 161
162 == Feedback == 162 == Feedback ==
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: 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:
164 http://wiki.fifengine.de/index.php?title=IRC 164 * http://wiki.fifengine.de/index.php?title=IRC
165 http://forums.fifengine.de/index.php?board=5.0 165 * http://forums.fifengine.de/index.php?board=5.0
166 166
167 == Signature == 167 == Signature ==
168 Have fun with the release and let us know what you think about it! 168 Have fun with the release and let us know what you think about it!
169 -- The FIFE team. 169 -- The FIFE team.
170 170