ggz.modules(5) GGZ Gaming Zone ggz.modules(5)NAME
ggz.modules - GGZ Gaming Zone module configuration file
DESCRIPTION
The GGZ Gaming Zone uses the file ggz.modules in order to configure which game modules are properly installed. The only approved method of
altering this file is using the ggz-config utility, however the file structure is documented here in order to facilitate manual repairs if
necessary.
PARAMETERS
The ggz.modules file is formattted in sections, each of which begins with a [SectionID] line. The first (required) section is [Games].
This section is followed by any number of game-specific sections named [g#].
The [Games] section is formatted as follows:
[Games]
*GameList* = GameName1 GameName2 ...
GameName1 = g1 g2 ...
GameName2 = g3 ...
*GameList*
Should be set to a list of all the game names which are currently installed. Each name should appear once and only once, and should
be the internal game name (eg: NetSpades) and not the full descriptive name of the game.
GameNameX
Should equal a game name from the *GameList*, a real world example would be NetSpades. It should be set to a list of unique game
section ID's of the form g#. Each game section ID must be the name of a section ID which follows in the file. The ID's need not be
in any specific order, and ID numbers may be skipped but NOT repeated.
A game section is formatted as follows:
[g#]
Author = Game's Author
CommandLine = /path/to/command [optionlist]
Frontend = FECODE
Homepage = URL to Game's homepage
Name = GameName
Protocol = ProtocolVersion
Version = GameVersion
Most of these parameters are self explanatory, however the following may need clarification:
[g#] This section code ID must be present in one of the game lists in the [Games] section above.
FECODE The frontend code should be set to either gtk or kde depending on which user interface the game was designed for. Note that the
game is expected to work with either the GTK+ or KDE clients, assuming that the user has the proper windowing system installed.
GameName
This must equal the game name (in the [Games] section) which properly points to this [g#] section.
ProtocolVersion
This will be used to match an installed game client with the protocol version currently used by the game server. This allows a new
game client to be installed, while retaining the old client for backwards compatibility with older servers.
GameVersion
This is simply the version of the game client itself. It need not be the same version as the game server as long as the Proto-
colVersion ID matches.
FILES
@ggzconfdir@/ggz.modules
AUTHORS
The GGZ Development Team <ggz-dev@mail.ggzgamingzone.org>
SEE ALSO ggz-config(6), ggz(7)The GGZ Development Team 0.0.14 ggz.modules(5)
Check Out this Related Man Page
ggz-config(6) GGZ Gaming Zone ggz-config(6)NAME
ggz-config - GGZ Gaming Zone configuration manager
SYNOPSIS
Query Mode:
ggz-config [--configdir] [--gamedir] [--datadir] [--protocol] [--version]
Install Mode:
ggz-config --install --modfile=FILENAME [--destdir] [--force]
Uninstall Mode:
ggz-config --remove --modfile=FILENAME
Repair Mode:
ggz-config --check
DESCRIPTION
The program ggz-config is a central tool and part of the client libraries package of the GGZ Gaming Zone. It can be used for several pur-
poses. Primarily it is used to maintain the ggz.modules configuration file by installing and removing game module information. This is
done with the --install and --remove modes of operation.
Additionally, the program can query the installation settings of the GGZ client libraries to assist in configuring the build process of a
client or game module.
OPTIONS
Query Mode Options
-c, --configdir
Output location of the GGZ client libraries configuration directory and exit. This value will usually be @ggzconfdir@ and is where
the file ggz.modules is located.
-g, --gamedir
Output location of the executable game modules and exit. Game modules in this directory are all game clients which are not
installed into a standard PATH directory, mostly because they only run when invoked by a GGZ core client. As a special module, the
game client wrapper ggzwrap is installed into this place. The gamedir is usually @ggzexecmoddir@.
-d, --datadir
Output location of game module data directory and exit. This is where games look for their graphics and level data. This will
likely resolve to @ggzdatadir@.
-p, --protocol
Query GGZ_CS_PROTO_VERSION - version of core protocol between the GGZ server and any GGZ core clients.
-h, --help
Output help information and exit.
-u, --usage
Print some ggz-config usage scenarios for quick reference.
-v, --version
Output version information and exit.
Install Mode Options
--install
Specifies that we are installing a game module description.
--modfile=FILENAME
Specifies the source module description file. FILENAME will often be named module.dsc, but this is merely a convention.
--force
Overwrite an existing module entry of the same name, author and version rather than returning an error.
-D, --destdir
Specifies that the $DESTDIR environment variable contains a directory to prepend to the path for the GGZ module configuration file
(ggz.modules). The only known purpose for this is for creating binary packages of GGZ games.
Uninstall Mode Options
--remove
Specifies that we are removing a game module description.
--modfile=FILENAME
Specifies the source module description file.
FILES
@ggzconfdir@/ggz.modules
Game module registry for all GGZ Gaming Zone core clients.
ENVIRONMENT VARIABLES
DESTDIR
Used during install process, most commonly by the build sequence of binary packages such as rpm or dpkg.
BUGS
The program is currently unable to detect many problems that could arise with an invalid ggz.modules file.
Probably others, too numerous to mention.
SEE ALSO ggz_h(3), ggzcore_h(3), ggzmod_h(3), libggz(3), libggzcore(3), libggzmod(3), attributes(5), ggz.modules(5), gnome-interfaces(5), ggz(6),
ggz-config(6), ggz(7)
GGZ Gaming Zone:
http://www.ggzgamingzone.org/
AUTHORS
The GGZ Development Team <ggz-dev@mail.ggzgamingzone.org>
Last edited by Michal Pryc, Sun Microsystems Inc., 2008.
The GGZ Development Team 0.0.14 ggz-config(6)