1ggz.modules(5)                  GGZ Gaming Zone                 ggz.modules(5)
2
3
4

NAME

6       ggz.modules - GGZ Gaming Zone module configuration file
7

DESCRIPTION

9       The  GGZ  Gaming  Zone  uses the file ggz.modules in order to configure
10       which game modules are properly installed.  The only approved method of
11       altering  this  file  is using the ggz-config utility, however the file
12       structure is documented here in order to facilitate manual  repairs  if
13       necessary.
14

PARAMETERS

16       The  ggz.modules  file  is formattted in sections, each of which begins
17       with a [SectionID] line.  The  first  (required)  section  is  [Games].
18       This  section is followed by any number of game-specific sections named
19       [g#].
20
21       The [Games] section is formatted as follows:
22
23       [Games]
24       *GameList* = GameName1 GameName2 ...
25       GameName1 = g1 g2 ...
26       GameName2 = g3 ...
27
28       *GameList*
29              Should be set to a list of all the game  names  which  are  cur‐
30              rently  installed.   Each name should appear once and only once,
31              and should be the internal game name (eg: NetSpades) and not the
32              full descriptive name of the game.
33
34       GameNameX
35              Should equal a game name from the *GameList*, a real world exam‐
36              ple would be NetSpades.  It should be set to a  list  of  unique
37              game  section ID's of the form g#.  Each game section ID must be
38              the name of a section ID which follows in the  file.   The  ID's
39              need not be in any specific order, and ID numbers may be skipped
40              but NOT repeated.
41
42
43       A game section is formatted as follows:
44
45       [g#]
46       Author = Game's Author
47       CommandLine = /path/to/command [optionlist]
48       Frontend = FECODE
49       Homepage = URL to Game's homepage
50       Name = GameName
51       Protocol = ProtocolVersion
52       Version = GameVersion
53
54       Most of these parameters are self explanatory,  however  the  following
55       may need clarification:
56
57       [g#]   This section code ID must be present in one of the game lists in
58              the [Games] section above.
59
60       FECODE The frontend code should be set to either gtk or  kde  depending
61              on  which  user  interface the game was designed for.  Note that
62              the game is expected  to  work  with  either  the  GTK+  or  KDE
63              clients,  assuming that the user has the proper windowing system
64              installed.
65
66       GameName
67              This must equal the game name (in  the  [Games]  section)  which
68              properly points to this [g#] section.
69
70       ProtocolVersion
71              This  will  be  used  to match an installed game client with the
72              protocol version currently used by the game server.  This allows
73              a  new  game  client  to  be  installed, while retaining the old
74              client for backwards compatibility with older servers.
75
76       GameVersion
77              This is simply the version of the game client itself.   It  need
78              not be the same version as the game server as long as the Proto‐
79              colVersion ID matches.
80

FILES

82       @ggzconfdir@/ggz.modules
83

AUTHORS

85       The GGZ Development Team <ggz-dev@mail.ggzgamingzone.org>
86

SEE ALSO

88       ggz-config(6), ggz(7)
89
90
91
92The GGZ Development Team            0.0.14                      ggz.modules(5)
Impressum