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