ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/deliantra/server/README
Revision: 1.43
Committed: Wed Apr 16 21:14:13 2008 UTC (16 years, 1 month ago) by root
Branch: MAIN
CVS Tags: rel-2_6, rel-2_54, rel-2_55, rel-2_56, rel-2_51, rel-2_52, rel-2_53
Changes since 1.42: +5 -3 lines
Log Message:
*** empty log message ***

File Contents

# Content
1 WHAT IS DELIANTRA?
2
3 This is a multiplayer graphical arcade and adventure game, that runs on
4 a client/server model. There are clients for Microsoft(R) Windows(TM)
5 and POSIX systems such as Linux and *BSD. To get the most joyful
6 experience, the Deliantra client should be used. This client is written
7 in Perl and utilises SDL with OpenGL to provide you with the most
8 immersive gameplay.
9
10 Deliantra has certain flavours from other games, especially Gauntlet (TM)
11 and Nethack/Moria.
12
13 Any number of players can move around in their own window on the
14 world, finding and using items and battle monsters. They can choose to
15 cooperate or compete in the same "world".
16
17
18 REQUIREMENTS
19
20 For UNIX, a modern C++ compiler with some extensions is required to
21 compile this game (g++ 4.x works). In addition, you will need the Perl
22 development libraries along with the following Perl modules (the server
23 is tested with perl 5.8.8, 5.8-maint and 5.10.0. A perl configured for
24 64 bit integer support is highly recommended to avoid overflows, but 32
25 bit perls are supported) and their dependencies. In general, the newest
26 version from CPAN will do. The configure script will complain when it
27 detects an unsuitable version.
28
29 - AnyEvent
30 - BDB **compiled against libdb4.[56] (libdb4.4 *might* work)**
31 - Compress::LZF
32 - Coro **SEE IMPORTANT NOTICE BELOW**
33 - Coro::EV
34 - Deliantra
35 - Digest::MD5
36 - EV
37 - IO::AIO
38 - JSON::XS
39 - Net::IRC3
40 - Pod::POM
41 - Safe::Hole
42 - Storable
43 - Time::HiRes
44 - URI
45 - YAML
46 - YAML::Syck
47
48 **NOTICE**: Deliantra uses an alternative signal stack, so you have to
49 use either the "u"context method (slow) or "a"ssembly when configuring
50 Coro.
51
52 Furthermore, you will need the following programs and libraries:
53
54 - gperf, the GNU perfect hash generator >= v3.0
55 - glib-2.0 >= v2.10
56 - libpng >= v1.2
57 - ImageMagick >= v6.0 (possibly higher, depending on its bugs)
58 - optipng => v0.5.5 (http://optipng.sf.net)
59 - pngnq >= v0.4 (http://freshmeat.net/redir/pngnq/53146/url_homepage/pngnq.html)
60 - rsync >= v2.6 (a must have anyways)
61
62 Your compiler must support the Library Technical Report 1 extensions and
63 the upcoming typeof extension. The GNU C++ compiler >= version 4.0 does
64 support all these.
65
66 On Debian GNU/Linux, you might get away with something like this for many of the
67 above dependencies:
68
69 apt-get install gperf optipng pngnq rsync imagemagick libglib2.0-dev libpng12-dev
70 apt-get install libpod-pom-perl libsafe-hole-perl libevent-perl
71
72 If you want to get sensible backtraces for error conditions at runtime
73 to be logged you also need the external addr2line program (part of GNU
74 binutils) in your PATH.
75
76
77 COMPILING
78
79 Deliantra has been known to compile on a wide variety of systems. It should
80 compile and run on most ISO C++ 200x and POSIX compliant systems.
81
82 To get generic directions on compilation, read the INSTALL file.
83
84
85 INSTALLATION/USAGE
86
87 Deliantra runs on a client/server model. You will also a client to
88 play. You can either connect to a server someone else has set up, or
89 run your own server and connect to that. There are a number of clients
90 available, but the recommended one is CFPlus (see below for URL).
91
92 To run your own server, you need to build the deliantra server binaries
93 and install them, then you will have to download and install map and
94 archetype packs:
95
96 Download both the cfmaps-<version> and cfarch-<version> archives, then
97 use cfutil to install both (the source directories must be writable for
98 this to work):
99
100 cfutil --install-maps path/to/cfmaps-<version>/
101 cfutil --install-arch path/to/cfarch-<version>/
102
103 Both processes can take some time, depending on your resources :) If you
104 plan to repeat the installation you should specify the --cache option
105 first, which will keep costly-to-generate files around for further runs
106 of cfutil:
107
108 cfutil --cache --install-maps path/to/cfmaps-<version>/
109 cfutil --cache --install-arch path/to/cfarch-<version>/
110
111 Atfer this you can then run the deliantra executable. This starts a
112 server which you/other people can connect to.
113
114
115 WEB SITES
116
117 The following web addresses have deliantra information that you may find
118 useful:
119
120 http://www.deliantra.net/ (The main site)
121
122
123 REPORTING BUGS
124
125 First, check the INSTALL file for common problems, and see if yours is
126 mentioned.
127
128 Bugs should be filed using the following email address:
129 support@deliantra.net
130
131 When reporting bugs, make sure you include the following:
132
133 * What version of deliantra did you use?
134 * What type of computer did you use (CPU type)
135 * What is the version of the OS?
136 * What windowing system are you using (e.g. openwindows, X.org, XFree86)
137 * What compiler (and its version) did you use (e.g. gcc, acc)?
138 * Which flags did you give it?
139 * If the bug happens when compiling deliantra, send an EXACT copy of the
140 compiler line, as well as the errors it puts out. Sending bugs of the
141 sort 'it failed with a line like ...' doesn't help any.
142 * If the bug happened while running deliantra:
143 - Include any output before to the bug.
144 - Give a description of what you did before the bug occured. The better
145 detailed the description, the better chance we have of figuring
146 out where the bug happened, or how we can recreate the bug.
147 - If possible, a stack trace from gdb (or other debugger) is very
148 helpful.
149
150 The more information provided, the better chance of the bug being fixed
151 in a timely fashion.
152
153
154 SUBMITTING PATCHES
155
156 Patches should be submitted to email address:
157 support@deliantra.net
158
159
160 PUBLIC SERVERS
161
162 The best way to find a server to play is to run the client
163 and hit "Server List" in the setup dialog (this varies
164 depending on your client).
165
166 The canonical server for use with Deliantra and CFPlus is
167 gameserver.deliantra.net, port 13327 (the default).
168
169
170 COPYRIGHT
171
172 Most files in this distribution are covered by the GNU General Public
173 License, version 3 (COPYING.GPL), or any later version, with the
174 exception of ext/affero.ext, which is covered by the GNU Affero General
175 Public License, Version 3 (COPYING.Affero). Please take note of the
176 special requirements of the Affero license with respect to network
177 servers and configure your network server according to the instructions
178 given in ext/affero.ext.
179
180
181 CONTACT
182
183 The authors can be reached via e-mail to support@deliantra.net
184