summaryrefslogtreecommitdiffstats
path: root/libtdegames/README
diff options
context:
space:
mode:
Diffstat (limited to 'libtdegames/README')
-rw-r--r--libtdegames/README25
1 files changed, 25 insertions, 0 deletions
diff --git a/libtdegames/README b/libtdegames/README
new file mode 100644
index 00000000..b96c1772
--- /dev/null
+++ b/libtdegames/README
@@ -0,0 +1,25 @@
+This directory contains the library for the tdegames packege.
+It is a collection of functions used by some games or which
+are useful for other games.
+
+Packagers note: it is recommended to put the directory "carddecks" into a separate
+package, as not all games using libtdegames use the carddecks as well.
+
+Contents:
+ kcarddialog: Access to carddeck selection and administration
+ for cardgames
+ kstdgameaction: just like kstdaction this provides some default action for
+ kde games. games often use different entries than other apps
+ (like "game" instead of "file"), so use this if possible
+ kgamemisc: some static method i didn't know a good class name for. it
+ currently features "randomName()" which will just give you a random name from
+ a list (translators note: happy translating ;) i copied kde-common/accounts
+ for this so there are nearly 300 entries...)
+ kgame: this is a complete network/game handling library. it constists of a lot
+ of classes which are explained in the kgame docu (as soon as it is
+ written)
+if you use libtdegames in your game please also add
+KGlobal::locale()->insertCatalogue("libtdegames");
+to main()
+This will add libtdegames.pot to your game and therefore all libtdegames
+strings get translated.