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