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