Mercurial > fife-parpg

comparison README @ 659:adb4b0e7c08c

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
* Added a bunch of changes to CHANGES. It should now be up to date * Added the FIFE ascii art header to INSTALL, and README * Updated README with some of the shooter demo info. TODO: update the "known issues" section.
author prock@33b003aa-7bff-0310-803a-e67f0ece8222
date Tue, 02 Nov 2010 18:51:10 +0000
parents ff36b24354c7
children b0733d998d0f
comparison
equal deleted inserted replaced
658:9fba00d9cdd5 659:adb4b0e7c08c
1
2 __/\\\\\\\\\\\\\\\___/\\\\\\\\\\\___/\\\\\\\\\\\\\\\___/\\\\\\\\\\\\\\\_
3 _\/\\\///////////___\/////\\\///___\/\\\///////////___\/\\\///////////__
4 _\/\\\__________________\/\\\______\/\\\______________\/\\\_____________
5 _\/\\\\\\\\\\\__________\/\\\______\/\\\\\\\\\\\______\/\\\\\\\\\\\_____
6 _\/\\\///////___________\/\\\______\/\\\///////_______\/\\\///////______
7 _\/\\\__________________\/\\\______\/\\\______________\/\\\_____________
8 _\/\\\__________________\/\\\______\/\\\______________\/\\\_____________
9 _\/\\\_______________/\\\\\\\\\\\__\/\\\______________\/\\\\\\\\\\\\\\\_
10 _\///_______________\///////////___\///_______________\///////////////__
11
1 == Introduction == 12 == Introduction ==
2 Welcome to the FIFE v0.3.1 README. This snapshot is based on SVN revision XXXX. 13 Welcome to the FIFE v0.3.2 README. This snapshot is based on SVN revision XXXX.
3 14
4 == Table of contents == 15 == Table of contents ==
5 1 Features 16 1 Features
6 2 License 17 2 License
7 3 FIFE Clients 18 3 FIFE Clients
17 28
18 == 2) License == 29 == 2) License ==
19 The source code (*.cpp, *.h & *.py) is licensed under LGPL 2.1 or newer: 30 The source code (*.cpp, *.h & *.py) is licensed under LGPL 2.1 or newer:
20 * http://www.gnu.org/licenses/lgpl-2.1.html 31 * http://www.gnu.org/licenses/lgpl-2.1.html
21 32
22 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. 33 Content was taken from a lot a lot of different 3rd party sources. Therefore each
34 client directory comes with a separate LICENSE file that states the origin of the
35 content, the author and the actual license it was published under.
23 36
24 37
25 == 3) FIFE Clients == 38 == 3) FIFE Clients ==
26 39
27 === 3.1) Editor === 40 === 3.1) Editor ===
41 The editor tool can be found within the <FIFE>/tools/editor directory. You can
42 launch it by running 'run.py'. It is used to edit map files for the tech demo
43 (rio do hola). Other clients extend it and use it to edit their maps.
28 44
29 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.
30 45
31 === 3.2) Rio De Hola === 46 === 3.2) Rio De Hola ===
47 Rio de hola is a technology demo showing off many of the FIFE features. It is
48 located in the <FIFE>/demos/rio_de_hola directory and can be launched by running
49 run.py. It was at one time meant to be an example game but we have moved away
50 from that idea and it is now more of a technology demo and a playground for
51 developers to test their code. It does serve as a good starting point for people
52 wishing to play around with FIFE or base your game off of.
32 53
33 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.
34 54
35 === 3.3) PyChan Example === 55 === 3.3) Shooter Demo ===
56 The Shooter demo was an attempt to show the versatility and flexibility of FIFE.
57 It is a simple side scrolling shooter that has a main menu, one level and an
58 end boss. Try your luck and see if you can defeat the boss!
36 59
37 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. 60 === 3.4) PyChan Example ===
61 Last but not least there is an example client residing in <FIFE>\demos\pychan_demo
62 that shows how the pychan GUI library works. Start the GUI demo application by
63 running pychan_test.py.
38 64
39 === 3.4) Configuring the Clients === 65
40 The engine utilizes special settings files for configuring FIFE. This file is called settings.py and resides in the same directory as the <FIFE>/clients/<CLIENT>/run.py scripts. You can customize FIFE by editing this file. 66 === 3.5) Configuring the Clients ===
67 The engine utilizes special settings files for configuring FIFE. This file is called
68 settings.py and resides in the same directory as the <FIFE>/clients/<CLIENT>/run.py
69 scripts. You can customize FIFE by editing this file.
70
41 71
42 == 4) Known issues == 72 == 4) Known issues ==
43 * Building the debug version of _fife.pyd fails with mingw 73 * Cannot build a usable debug version of _fife_d.pyd with mingw
44 * 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. 74 * Win32 users tend to suffer from problems with the OpenAL drivers. If you don't
75 hear sound while running a FIFE client, run oalinst.exe that ships with the
76 Win32 FIFE Development Kit. This is the latest OpenAL driver for Win32.
45 * The unittests are broken on Win32 (if used in combination with scons & mingw). 77 * The unittests are broken on Win32 (if used in combination with scons & mingw).
46 * Segfault when closing via windowmanger (#407)
47 * VFS filename case issue (#418 and #380)
48 * SWIG wrappers don't handle simple output parameters (#340)
49 * Camera name clashes when opening maps with the same camera identifier (#342)
50 * Python.exe crashes when linked against the guichan debug libs in MSVC2008 (#357)
51 * Instance rotation problems (#361)
52 * Widgts are not properly resized when loaded from XML (#367)
53 * Cannot show/hide child widgets in containers (#357) 78 * Cannot show/hide child widgets in containers (#357)
54 * OpenGL leaves traces on screen after closing maps (#392)
55 * Freeze when setting text in a label (#408)
56 * VFS crashes when trying to enter a restricted path (#413)
57 * SDL renderer does not support colorkeying and png images (#146)
58 * UnitTests do not work when started with MSVS2005 (#352)
59 * No non-renderable font image when a character is not found (#302) 79 * No non-renderable font image when a character is not found (#302)
60 * FIFE does not compile with vanilla libpng sources (#385) 80 * Guichan widgets do not correctly handle meta characters (shift, ctrl, alt,
61 * Guichan widgets do not correctly handle meta characters (shift, ctrl, alt, etc) (#412) 81 etc) (#412)
62 * Cameras must be attached to layers and not maps as they should be (#305) 82 * Cameras must be attached to layers and not maps as they should be (#305)
63 * Map editor clobbers custom attribues in map file (#379) 83 * Map editor clobbers custom attribues in map file (#379)
64 * Darwin users will not have UTF8 support if they install guichan from MacPorts. 84 * Darwin users will not have UTF8 support if they install guichan from MacPorts.
65 85
86
66 == 5) Feedback == 87 == 5) Feedback ==
67 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: 88 We appreciate every kind of feedback concerning the release, the project in general
89 and the bundled techdemo. Feedback is a great way to help us to improve FIFE. If you
90 would like to get in contact with us and provide feedback you can either visit our
91 IRC channel or our forums:
68 * http://wiki.fifengine.de/index.php?title=IRC 92 * http://wiki.fifengine.de/index.php?title=IRC
69 * http://forums.fifengine.de/index.php?board=5.0 93 * http://forums.fifengine.de/index.php?board=5.0
94
70 95
71 == 6) Closing Notes == 96 == 6) Closing Notes ==
72 Have fun with the release and let us know what you think about it! 97 Have fun with the release and let us know what you think about it!
73 -- The FIFE team. 98 -- The FIFE team.
74 99