ggz.modules(5) [opensolaris man page]

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

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.modules(5)

Check Out this Related Man Page

ggz-wrapper(6)							  GGZ Gaming Zone						    ggz-wrapper(6)

NAME

       ggz-wrapper - GGZ Gaming Zone command line core client

SYNOPSIS

       ggz-wrapper [--gametype GAMENAME] [--user NAME] [--destnick NAME] [OPTION...]

DESCRIPTION

       The  GGZ  Gaming  Zone allows people to play many games online using so-called GGZ core clients which are chat clients with integrated game
       launchers.

       The ggz-wrapper tool is a small special GGZ core client for the command line. It does not support chat or  display  of  rooms,  tables  and
       players,  but  instead  is useful for fast launching of online games.  Therefore, its main purpose is to be invoked from instant messengers
       such as gaim or kopete.

       It currently supports all two-player games, as human against human or human against bot. If no options are given, ggz-wrapper will invoke a
       Tic-Tac-Toe game client on the default GGZ server, live.ggzgamingzone.org, logging in as guest user.

OPTIONS

       --gametype=GAMENAME
	      The  name  of  the game to play, e.g. TicTacToe or Chess.  This option expects a case-sensitive argument which must match one of the
	      available game modules in ggz.modules. If the game type is not supported by the specified GGZ server, the invocation will fail.

       --user=NAME
	      The name of the player who is running the client. The default is to run with an automatically generated guest user name. In order to
	      use a registered name, the option --password is implied.

       --destnick=NAME
	      The  name of the other player. If omitted or empty, the player running the client will launch the table (game host). If empty, other
	      player will be the bot.  If not empty, player will join the table which the other player already launched.

       --password=PASSWORD
	      Password to use in case of playing as a registered user. Note that on a multi-user systems, other  users	might  see  the  password,
	      which is a security risk.

       --server=SERVER
	      The server to play on. If not specified, the default server is ggz://live.ggzgamingzone.org.

       --port=PORT
	      The port to use to connect to the GGZ server. PORT is almost always 5688, so this option is rarely needed.

AUTHORS

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

SEE ALSO

       ggz.modules(5), ggz(7)

The GGZ Development Team					      0.0.14							    ggz-wrapper(6)

Linux and UNIX Man Pages

ggz.modules(5) [opensolaris man page]

Check Out this Related Man Page