
__/\\\\\\\\\\\\\\\___/\\\\\\\\\\\___/\\\\\\\\\\\\\\\___/\\\\\\\\\\\\\\\_        
 _\/\\\///////////___\/////\\\///___\/\\\///////////___\/\\\///////////__       
  _\/\\\__________________\/\\\______\/\\\______________\/\\\_____________      
   _\/\\\\\\\\\\\__________\/\\\______\/\\\\\\\\\\\______\/\\\\\\\\\\\_____     
    _\/\\\///////___________\/\\\______\/\\\///////_______\/\\\///////______    
     _\/\\\__________________\/\\\______\/\\\______________\/\\\_____________   
      _\/\\\__________________\/\\\______\/\\\______________\/\\\_____________  
       _\/\\\_______________/\\\\\\\\\\\__\/\\\______________\/\\\\\\\\\\\\\\\_ 
        _\///_______________\///////////___\///_______________\///////////////__
        
== Introduction ==
Welcome to the FIFE v0.3.3 README. This snapshot is based on SVN revision 3750.

== Table of contents ==
1 Features
2 License
3 FIFE Clients
4 Known Issues
5 Feedback
6 Closing Notes


== 1) Features ==
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


== 2) License ==
The source code (*.cpp, *.h & *.py) is licensed under LGPL 2.1 or newer:
 * http://www.gnu.org/licenses/lgpl-2.1.html

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.


== 3) FIFE Clients ==

=== 3.1) Editor ===
The editor tool can be found within the <FIFE>/tools/editor directory. You can 
launch it by running 'run.py'.  It is used to edit map files for the tech demo 
(rio do hola).  Other clients extend it and use it to edit their maps.


=== 3.2) Rio De Hola ===
Rio de hola is a technology demo showing off many of the FIFE features.  It is 
located in the <FIFE>/demos/rio_de_hola directory and can be launched by running 
run.py.  It was at one time meant to be an example game but we have moved away 
from that idea and it is now more of a technology demo and a playground for 
developers to test their code.  It does serve as a good starting point for people 
wishing to play around with FIFE or base your game off of.


=== 3.3) Shooter Demo ===
The Shooter demo was an attempt to show the versatility and flexibility of FIFE.
It is a simple side scrolling shooter that has a main menu, one level and an
end boss.  Try your luck and see if you can defeat the boss!


=== 3.4) PyChan Example ===
Last but not least there is an example client residing in <FIFE>\demos\pychan_demo 
that shows how the pychan GUI library works. Start the GUI demo application by 
running pychan_test.py.


=== 3.5) Configuring the Clients ===
The engine utilizes special settings files for configuring FIFE. This file is called 
settings.xml and resides in your home directory (in Application Data for Windows users).
For the Shooter demo this file is in the same directory as the shooter demo.


== 4) Known issues ==
Documentation
 * Bug in dep_analyzer.py which prevents graphs from being generated (#554)
 * Crashing when making application window active in Mac OSX (#515)
 * Some unit tests are broken (#423)
 * Atlas Creator needs to be documented (#559)

Engine
 * Using FIFE Console breaks gettext calls, thus crashing the client (#560)
 * ActionFrame is not functional (#573)
 * Fallback solution for special characters (Fontsupport) (#302)
 * cameras must be attached to layers (#305)
 * Loaders have a circular import (#478)
 * Several FIFE::Command type events are not being handled correctly (#503)
 * Win32 users tend to suffer from problems with the OpenAL drivers. If you don't 
   hear sound while running a FIFE client, run oalinst.exe that ships with the 
   Win32 FIFE Development Kit.  This is the latest OpenAL driver for Win32.

Guichan/Pychan
 * Fix UTF8 support using vanilla guichan source (#432)
 * Pychan dropdown menus crash FIFE-based client on win32 (#508)
 * De-couple FIFE from Guichan (#549)
 * Button doesn't react to click when drawn below mouse pointer (#387)
 * Pychan dropdowns refuse to open if there is no space below (#445)
 * Slider size is overwritten by label max_size when residing in the same (parent) box (#488)
 * Pychan widget constructors silently ignore unexpected keyword arguments (#520)
 * Borders are not rendered on edges of widgets that touch their parent container's edge. (#522)
 * GuiImage unable to find loader for JPEG in ImagePool (#548)
 * Cursor is sometimes displayed over letter in TextField (#547)

Build
 * Uninstaller Doesn't Remove fife Module (#526)
 * libguichan fails to install when src path contains a space (#533)
 * Improve build system shared library support on linux (#575, $435)
 * Cannot build a usable debug version of _fife_d.pyd with mingw

Editor
 * Clean up editor code to match python coding standards (#371)
 * Map editor shouldn't clobber custom attributes (#379)
 * Editor crashes after docking the object editor and closing map (#450)
 * History bugs (#452)
 * Placing an instance on top of another then undoing resets the original instances properties (#459)
 * Should be able to set the default zoom level for a camera (#467)
 * Editor should allow you to add additional import statements (#468)
 * Editor file browser widget can't be closed (#499)
 * Misc FIFE Editor crashes (user input validation/exception handling missing) (#537)

== 5) Feedback ==
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:
 * http://wiki.fifengine.de/index.php?title=IRC
 * http://forums.fifengine.de/index.php?board=5.0


== 6) Closing Notes ==
Have fun with the release and let us know what you think about it!
-- The FIFE team.

http://www.fifengine.net/

2011/10/04
