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