13360N/A<!DOCTYPE REFENTRY PUBLIC "-//Sun Microsystems//DTD DocBook V3.0-Based SolBook Subset V2.0//EN" [
13360N/A<!--ArborText, Inc., 1988-1999, v.4002-->
13360N/A<!ENTITY cmd "libggzcore">
13360N/A<!ENTITY % commonents SYSTEM "smancommon.ent">
13360N/A%commonents;
13360N/A<!ENTITY % booktitles SYSTEM "booktitles.ent">
13360N/A%booktitles;
13360N/A<!ENTITY suncopy "Copyright (c) 2008, Sun Microsystems, Inc. All Rights Reserved.">
13360N/A]>
13360N/A<?Pub UDT _bookmark _target>
13360N/A<?Pub Inc>
13360N/A<refentry id="libggzcore-3">
13360N/A<!-- %Z%%M% %I% %E% SMI; -->
13360N/A<refmeta>
13360N/A <refentrytitle>libggzcore</refentrytitle><manvolnum>3</manvolnum>
13360N/A <refmiscinfo class="date">29 May 2008</refmiscinfo>
13360N/A <refmiscinfo class="sectdesc">&man3;</refmiscinfo>
13360N/A <refmiscinfo class="software">&release;</refmiscinfo>
13360N/A <refmiscinfo class="arch">generic</refmiscinfo>
13360N/A <refmiscinfo class="copyright">&suncopy;</refmiscinfo>
13360N/A</refmeta>
13360N/A
13360N/A<indexterm><primary>libggzcore</primary></indexterm>
13360N/A<indexterm><primary>The GGZ Gaming Zone core client library</primary></indexterm>
13360N/A
13360N/A<refnamediv id="libggzcore-3-name">
13360N/A <refname>libggzcore</refname>
13360N/A <refpurpose>
13360N/AThe GGZ Gaming Zone core client library
13360N/A</refpurpose>
13360N/A</refnamediv>
13360N/A<refsect1 id="libggzcore-3-desc">
13360N/A <title>&desc-tt;</title>
13360N/A <para>
13360N/AThis library is used by client programs to connect to the GGZ
13360N/AGaming Zone server, handle game rooms, control user participation in the games,
13360N/Acontrol chat and player properties.
13360N/A </para>
13360N/A <para>
13360N/AThe <filename>ggzcore</filename> library handles the connection of a client
13360N/Aapplication to the GGZ Gaming Zone server. It starts with offering a global
13360N/Aconfiguration object for storing connection profiles for each server. The
13360N/Aserver list can be maintained by hand or updated via the GGZ metaserver. After
13360N/Athis it goes on to callback registration for the connection, negotiation and
13360N/Aauthentication methods, which might include guest logins, first time player or
13360N/Aregistered player on the GGZ server.
13360N/A </para>
13360N/A <para>
13360N/AAfter a login it handles the global server object, the current room object and,
13360N/Awhen playing a game, the active game object. Additional objects include the
13360N/Atable the game is associated with, players, game types and game modules which
13360N/Arepresent client-side game executables.
13360N/A </para>
13360N/A <para>
13360N/AAlternatively, a game can integrate ggzcore directly instead of being launched
13360N/Aby a ggzcore-using GGZ core client, which is known as embedded ggzcore.
13360N/A </para>
13360N/A <para>
13360N/AOther tasks handled by the library are querying the local game registry with
13360N/Aall properties per game; retrieving the server message of the day (MOTD) or
13360N/Aplayer statistics; handling public, private and per-table chat as well as
13360N/Aadministrative messages; and managing the game launch and join events for
13360N/Aplayers and spectators.
13360N/A </para>
13360N/A</refsect1>
13360N/A
13360N/A<refsect1 id="libggzcore-3-file">
13360N/A <title>&file-tt;</title>
13360N/A <para>The following files are used by this library:</para>
13360N/A <variablelist termlength="wide">
13360N/A <varlistentry>
13360N/A <term><filename>/usr/lib/&cmd;.so</filename> </term>
13360N/A <listitem>
13360N/A <para>The GGZ Gaming Zone core client shared library</para>
13360N/A </listitem>
13360N/A </varlistentry>
13360N/A </variablelist>
13360N/A</refsect1>
13360N/A
13360N/A<refsect1 id="libggzcore-3-attr">
13360N/A <title>&attr-tt;</title>
13360N/A <para>See <olink targetdocent="REFMAN5" localinfo="attributes-5"><citerefentry>
13360N/A<refentrytitle>attributes</refentrytitle><manvolnum>5</manvolnum></citerefentry>
13360N/A</olink> for descriptions of the following attributes:
13360N/A </para>
13360N/A <informaltable frame="all">
13360N/A <tgroup cols="2" colsep="1" rowsep="1">
13360N/A <colspec colname="COLSPEC0" colwidth="1*">
13360N/A <colspec colname="COLSPEC1" colwidth="1*">
13360N/A <thead>
13360N/A <row>
13360N/A <entry align="center" valign="middle">ATTRIBUTE TYPE</entry>
13360N/A <entry align="center" valign="middle">ATTRIBUTE VALUE</entry>
13360N/A </row>
13360N/A </thead>
13360N/A <tbody>
13360N/A <row>
13360N/A <entry><para>Availability</para></entry>
18745N/A <entry><para>games/gnome-games</para></entry>
13360N/A </row>
13360N/A <row>
13360N/A <entry colname="COLSPEC0"><para>Interface stability</para></entry>
13360N/A <entry colname="COLSPEC1"><para>Volatile</para></entry>
13360N/A </row>
13360N/A </tbody>
13360N/A </tgroup>
13360N/A </informaltable>
13360N/A</refsect1>
13360N/A
13360N/A<refsect1 id="libggzcore-3-also"><title>&also-tt;</title>
13360N/A <!--Reference to another man page-->
13360N/A <!--Reference to a Help manual-->
13360N/A <!--Reference to a book.-->
13360N/A<para>
13360N/A<citerefentry><refentrytitle>ggz_h</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
13360N/A<citerefentry><refentrytitle>ggzcore_h</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
13360N/A<citerefentry><refentrytitle>ggzmod_h</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
13360N/A<citerefentry><refentrytitle>libggz</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
13360N/A<citerefentry><refentrytitle>libggzmod</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
13360N/A<citerefentry><refentrytitle>attributes</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
13360N/A<citerefentry><refentrytitle>ggz.modules</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
13360N/A<citerefentry><refentrytitle>gnome-interfaces</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
13360N/A<citerefentry><refentrytitle>ggz</refentrytitle><manvolnum>6</manvolnum></citerefentry>,
13360N/A<citerefentry><refentrytitle>ggz-config</refentrytitle><manvolnum>6</manvolnum></citerefentry>,
13360N/A<citerefentry><refentrytitle>ggz</refentrytitle><manvolnum>7</manvolnum></citerefentry>
13360N/A</para>
13360N/A<variablelist termlength="wholeline">
13360N/A<varlistentry>
13360N/A<term><filename>GGZ Gaming Zone:</filename></term>
13360N/A<listitem><para>
13360N/A<programlisting>
13360N/A<literal>http://www.ggzgamingzone.org/</literal>
13360N/A<literal>http://www.ggzgamingzone.org/docs/api/libggz/</literal>
13360N/A<literal>http://www.ggzgamingzone.org/docs/api/ggzcore/</literal>
13360N/A<literal>http://www.ggzgamingzone.org/docs/api/ggzmod/</literal>
13360N/A</programlisting></para>
13360N/A</listitem>
13360N/A</varlistentry>
13360N/A</variablelist>
13360N/A</refsect1>
13360N/A
13360N/A<refsect1 id="libggzcore-3-note"><title>&note-tt;</title>
13360N/A <para>Written by Michal Pryc, Sun Microsystems Inc., 2008.</para>
13360N/A</refsect1>
13360N/A</refentry>