1
.TH "ggz-wrapper" "6" "0.0.11" "The GGZ Development Team" "GGZ Gaming Zone"
1
.TH "ggz-wrapper" "6" "0.0.14" "The GGZ Development Team" "GGZ Gaming Zone"
4
4
ggz\-wrapper \- GGZ Gaming Zone command line core client
7
\fBggz\-wrapper [\-\-gametype\fR \fIGAMENAME\fP] [\fB\-\-user\fR \fINAME\fP] [\fB\-\-destnick\fR \fINAME\fP[
7
\fBggz\-wrapper\fR [\fB\-\-gametype\fR \fIGAMENAME\fP] [\fB\-\-user\fR \fINAME\fP]
8
[\fB\-\-destnick\fR \fINAME\fP] [\fIOPTION\fR...]
10
The ggz-wrapper tool is a small GGZ core client for the command line.
11
It does not support chat or display of rooms, tables and players,
12
but instead is useful for fast launching of games.
11
The GGZ Gaming Zone allows people to play many games online using so-called
12
GGZ core clients which are chat clients with integrated game launchers.
14
The \fBggz-wrapper\fR tool is a small special GGZ core client for the command
15
line. It does not support chat or display of rooms, tables and players,
16
but instead is useful for fast launching of online games.
17
Therefore, its main purpose is to be invoked from instant messengers such
18
as \fBgaim\fR or \fBkopete\fR.
14
20
It currently supports all two-player games, as human against human or
21
human against bot. If no options are given, \fBggz-wrapper\fR will invoke a
22
Tic-Tac-Toe game client on the default GGZ server, \fIlive.ggzgamingzone.org\fR,
23
logging in as guest user.
18
26
\fB\-\-gametype=\fR\fIGAMENAME\fP
19
27
The name of the game to play, e.g. TicTacToe or Chess.
20
This option expects a case-sensitive argument.
28
This option expects a case-sensitive argument which must match one of the
29
available game modules in \fIggz.modules\fR. If the game type is not supported
30
by the specified GGZ server, the invocation will fail.
22
32
\fB\-\-user=\fR\fINAME\fP
23
The name of the player who is running the client.
33
The name of the player who is running the client. The default is to run with
34
an automatically generated guest user name. In order to use a registered name,
35
the option --password is implied.
25
37
\fB\-\-destnick=\fR\fINAME\fP
26
38
The name of the other player. If omitted or empty, the player running the client
27
39
will launch the table (game host). If empty, other player will be the bot.
28
If not empty, player will join the table.
40
If not empty, player will join the table which the other player already launched.
42
\fB\-\-password=\fR\fIPASSWORD\fP
43
Password to use in case of playing as a registered user. Note that on a
44
multi-user systems, other users might see the password, which is a security risk.
46
\fB\-\-server=\fR\fISERVER\fP
47
The server to play on. If not specified, the default server is
48
\fIggz://live.ggzgamingzone.org\fR.
50
\fB\-\-port=\fR\fIPORT\fP
51
The port to use to connect to the GGZ server. \fIPORT\fR is almost always
52
5688, so this option is rarely needed.
32
56
The GGZ Development Team
33
57
<ggz\-dev@mail.ggzgamingzone.org>
60
ggz.modules(5), ggz(7)
added
removed
man/ggz-wrapper.6
