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