Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

libggzcore(3) [opensolaris man page]

libggzcore(3)							C Library Functions						     libggzcore(3)

NAME

       libggzcore - The GGZ Gaming Zone core client library

DESCRIPTION

       This  library  is  used	by  client programs to connect to the GGZ Gaming Zone server, handle game rooms, control user participation in the
       games, control chat and player properties.

       The ggzcore library handles the connection of a client application to the GGZ Gaming Zone server. It starts with offering a global configu-
       ration object for storing connection profiles for each server. The server list can be maintained by hand or updated via the GGZ metaserver.
       After this it goes on to callback registration for the connection, negotiation  and  authentication  methods,  which  might  include  guest
       logins, first time player or registered player on the GGZ server.

       After  a  login	it  handles the global server object, the current room object and, when playing a game, the active game object. Additional
       objects include the table the game is associated with, players, game types and game modules which represent client-side game executables.

       Alternatively, a game can integrate ggzcore directly instead of being launched by a ggzcore-using GGZ core client, which is known as embed-
       ded ggzcore.

       Other  tasks handled by the library are querying the local game registry with all properties per game; retrieving the server message of the
       day (MOTD) or player statistics; handling public, private and per-table chat as well as administrative  messages;  and  managing  the  game
       launch and join events for players and spectators.

FILES

       The following files are used by this library:

       /usr/lib/libggzcore.so	       The GGZ Gaming Zone core client shared library

ATTRIBUTES

       See attributes(5) for descriptions of the following attributes:

       +-----------------------------+-----------------------------+
       |      ATTRIBUTE TYPE	     |	    ATTRIBUTE VALUE	   |
       +-----------------------------+-----------------------------+
       |Availability		     |SUNWgnome-games		   |
       +-----------------------------+-----------------------------+
       |Interface stability	     |Volatile			   |
       +-----------------------------+-----------------------------+

SEE ALSO

       ggz_h(3),  ggzcore_h(3),  ggzmod_h(3),  libggz(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/
	   http://www.ggzgamingzone.org/docs/api/libggz/
	   http://www.ggzgamingzone.org/docs/api/ggzcore/
	   http://www.ggzgamingzone.org/docs/api/ggzmod/

NOTES

       Written by Michal Pryc, Sun Microsystems Inc., 2008.

SunOS 5.11							    29 May 2008 						     libggzcore(3)

Check Out this Related 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)
Man Page