Mercurial > fife-parpg
comparison ext/guichan-0.8.1/README @ 0:4a0efb7baf70
* Datasets becomes the new trunk and retires after that :-)
| author | mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 |
|---|---|
| date | Sun, 29 Jun 2008 18:44:17 +0000 |
| parents | |
| children |
comparison
equal
deleted
inserted
replaced
| -1:000000000000 | 0:4a0efb7baf70 |
|---|---|
| 1 IMPORTANT! | |
| 2 ========= | |
| 3 Guichan is currently in a beta stage. This means that the API is not fixed and | |
| 4 may change in the future. Every API change will break compatibility between | |
| 5 older versions of Guichan. | |
| 6 | |
| 7 INTRODUCTON TO GUICHAN | |
| 8 ====================== | |
| 9 Guichan is a C++ GUI library designed for games. It comes with a standard set | |
| 10 of 'widgets' and can use several different objects for displaying graphics and | |
| 11 capturing user input. Guichan has an abstract design which allows users of | |
| 12 Guichan to use different objects for displaying of graphics and grabbing of | |
| 13 user input. Guichan comes with three implemented graphics objects (SDLGraphics, | |
| 14 OpenGLGraphics and AllegroGraphics) and two implemented input objects (SDLInput | |
| 15 and AllegroInput). Due to Guichan's extendible nature, new objects can also be | |
| 16 created by the developer to suit their needs. As Guichan is designed for | |
| 17 games, Guichan lacks many features of more advanced GUI libraries (such as GTK | |
| 18 and QT). However, a game developer may not normally require all the advanced | |
| 19 features of the larger GUI libraries. Guichan aims to keep small and simple, | |
| 20 thus avoiding the complication and large dependencies found with some other GUI | |
| 21 libraries. Guichan is small but contains all basic GUI features making it ideal | |
| 22 for games. | |
| 23 | |
| 24 Guichan allows the developer control over the initialization of external | |
| 25 libraries, giving a degree of freedom which is almost required in game | |
| 26 development, but not provided by some GUI libraries. Guichan should not be | |
| 27 considered a full GUI library but rather a tool or helper library for game | |
| 28 development. | |
| 29 | |
| 30 The basic nature of Guichan means that it comes with a small number of default | |
| 31 widgets. There exists no themes or theme handling for Guichan, as their | |
| 32 implementation would increase the size and complexity of the library | |
| 33 unnecessarily. Instead, the developer creates their own new widgets by | |
| 34 inheriting from the standard widgets or by overloading standard widget | |
| 35 functions. This makes Guichan much more flexible for customisation than theme | |
| 36 based GUIs, and more natural to use for C++ developers, as they need only learn | |
| 37 the API instead of a whole new theming system. | |
| 38 | |
| 39 FOR MORE INFORMATION AND DOWNLOADS | |
| 40 ================================== | |
| 41 For more general information about Guichan and/or downloads related to Guichan | |
| 42 please visit the Guichan homepage at http://guichan.sourceforge.net. | |
| 43 | |
| 44 GETTING HELP WITH GUICHAN | |
| 45 ========================= | |
| 46 If you need help with Guichan, the best way to proceed is to ask questions | |
| 47 either by joining the users mailing list or by joining our forum. Information | |
| 48 about Guichan's mailing lists and our forum is found at the Guichan homepate at | |
| 49 http://guichan.sourceforge.net. | |
| 50 | |
| 51 | |
| 52 GETTING INVOLVED WITH GUICHAN DEVELOPMENT | |
| 53 ========================================= | |
| 54 If you want to get involved with Guichan development, the best way to proceed | |
| 55 is to suggest improvements to Guichan either by joining the developers mailing | |
| 56 list or by joining our forum. Information about Guichan's mailing lists and our | |
| 57 forum is found at the Guichan homepate at http://guichan.sourceforge.net. | |
| 58 | |
| 59 By Olof Naessén 2006-06-30. |