ggzwrap(1) [suse man page]

ggzwrap(1)							  GGZ Gaming Zone							ggzwrap(1)

NAME

       ggzwrap - GGZ Gaming Zone game client wrapper

SYNOPSIS

       ggzwrap [OPTION...] --exec=GAME

DESCRIPTION

       This  wrapper  takes the place of a game client, and relays the control messages between the game and the invoking instance, which is a GGZ
       core client. One task is to manage different file descriptors than the ones which are normally used.  The GGZ clients do currently communi-
       cate using a socket which is passed in the environment variable GGZSOCKET, usually being fd 53 on the client side, so a call to:

       ggzwrap --fdin=$GGZSOCKET --fdout=$GGZSOCKET --exec=gameclient

       would  be equivalent to calling the client directly. However, there are games which communicate using the standard input/output facilities,
       so they need a redirection like:

       ggzwrap --fdin=0 --fdout=1 --exec=gameclient

       The GGZ game Muehle uses ggzwrap to demonstrate that game clients do not necessarily need to use any GGZ libraries. The downside is that  a
       lot  of	game client functionality will not be available.  Game clients which want to make use of the wrapper must add a command similar to
       the one above into the file ggz.modules.

OPTIONS

       --fdin=FD
	      File descriptor on which the game expects its input.

       --fdout=FD
	      File descriptor to which the game writes its output.

       --convert
	      This option automatically converts strings from network format to host format (more correctly, from libggz's easysock format to  the
	      normal null-terminated one) for the game server, and back in the other direction. This will be needed for most games.

       --exec=GAME
	      The game client to launch as a child process.

ENVIRONMENT VARIABLES

       GGZMODE
	      Set by a GGZ core client to tell games they're running in GGZ mode.

       GGZSOCKET
	      File descriptor for the connection to the invoking GGZ core client.

AUTHORS

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

SEE ALSO

       shadowbridge(6), ggz.modules(5), ggz(7)

The GGZ Development Team					      0.0.14								ggzwrap(1)

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)