aboutsummaryrefslogtreecommitdiff
path: root/games/openjazz/openjazz.pod
blob: b2ae3bd6fcbf0d35d9174caea47d06d9a635b520 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
# pod source for openjazz man page
# pod2man -s6 -r20190106 --stderr -cSlackBuilds.org openjazz.pod > openjazz.6

=pod

=head1 NAME

B<openjazz> - free/open-source game engine for Jazz Jackrabbit

=head1 SYNOPSIS

B<openjazz> I<[-f]> I<[dir] ...>

B<openjazz-shareware> I<-f>

=head1 DESCRIPTION

OpenJazz is a free, open-source version of the classic Jazz Jackrabbit(tm)
games. OpenJazz can be compiled on a wide range of operating systems,
including Windows 98/Me/XP and Linux. OpenJazz requires the files
from any of the following games:

=over

=item Jazz Jackrabbit

=item Jazz Jackrabbit CD

=item Jazz Jackrabbit Shareware Edition

=item Jazz Jackrabbit Christmas Edition

=item Jazz Jackrabbit: Holiday Hare 1995

=back

OpenJazz will not work with any of the Jazz Jackrabbit 2 games. Don't
get confused: there's a "Holiday Hare 1998", which isn't supported
(only the 1995 version is).

There is no support for saving/loading the game. Multiplayer
is supported, but not well tested.

B<openjazz-shareware> launches the shareware version of the
game. It's just a wrapper script that executes "openjazz
/usr/share/games/openjazz/shareware".

To play one of the retail games (listed above), copy its data files to
a directory, then either run B<openjazz> from within that directory,
or else run it with the full path to the directory as an argument.

=head1 OPTIONS

B<-f> starts the game fullscreen. Any other option beginning with - will
be ignored. Anything else is treated as a directory to be added to the
file search path.

=head1 FILES

Game data files must be named in uppercase (e.g. B<BLOCKS.000>).

The search path for game data files includes, in order:

=over

=item the current directory

=item $HOME/.openjazz/

=item all paths listed on the command line I<in reverse order>

=back

In addition, the file B<openjazz.000> (containing the OpenJazz logo,
note the lowercase name) will be searched for in B</usr/share/games/openjazz>
after all other directories (so each separate game doesn't need its
own copy, when you've got multiple games installed).

B<$HOME/.openjazz/> stores user preferences (B<openjazz.cfg>) and any
custom levels downloaded from multiplayer servers. Will be created
if it doesn't exist. B<openjazz.cfg> is not human-readable nor
editable.

=head1 SEE ALSO

B<http://www.alister.eu/jazz/oj/faq.php>

=head1 AUTHORS

B<openjazz> is copyright (c) 2005-2013 Alister Thomson.

This man page written by B. Watson for the SlackBuilds.org project, and may
be used by anyone.