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