ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/deliantra/server/README
(Generate patch)

Comparing deliantra/server/README (file contents):
Revision 1.10 by root, Fri Apr 27 19:53:04 2007 UTC vs.
Revision 1.46 by elmex, Tue Sep 23 14:41:26 2008 UTC

1WHAT IS CROSSFIRE? 1WHAT IS DELIANTRA?
2 2
3 This is a multiplayer graphical arcade and adventure game, that runs on 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) 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 5 and POSIX systems such as Linux and *BSD. To get the most joyful
6 experience, the Crossfire+ client should be used. This client is written 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 7 in Perl and utilises SDL with OpenGL to provide you with the most
8 immersive gameplay. 8 immersive gameplay.
9 9
10 Crossfire has certain flavours from other games, especially Gauntlet (TM) 10 Deliantra has certain flavours from other games, especially Gauntlet (TM)
11 and Nethack/Moria. 11 and Nethack/Moria.
12 12
13 Any number of players can move around in their own window on the 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 14 world, finding and using items and battle monsters. They can choose to
15 cooperate or compete in the same "world". 15 cooperate or compete in the same "world".
16 16
17 17
18REQUIREMENTS 18REQUIREMENTS
19 19
20 For UNIX, a modern C++ compiler with some extensions is required to 20 For UNIX, a modern C++ compiler with some extensions is required to
21 compile this game. In addition, you will need the Perl development 21 compile this game (g++ 4.x works). In addition, you will need the Perl
22 libraries along with the following Perl modules (the server is tested 22 development libraries along with the following Perl modules (the server
23 with perl 5.8.8 and 5.8-maint). 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.
24 28
25 - BDB >= v0.1 29 - AnyEvent
30 - AnyEvent::AIO
31 - AnyEvent::BDB
32 - BDB **compiled against libdb4.[567] (libdb4.4 *might* work)**
26 - Compress::LZF >= v1.71 33 - Compress::LZF
27 - Coro >= v3.62 34 - Coro **SEE IMPORTANT NOTICE BELOW**
28 - Coro::Event >= v2.1 35 - Coro::EV
29 - Crossfire >= v0.97 36 - Deliantra
30 - Digest::MD5 >= v2.0 37 - Digest::MD5
31 - Event >= v1.08 38 - EV
32 - IO::AIO >= 2.32 39 - IO::AIO
33 - JSON::XS => 1.11 40 - JSON::XS
41 - AnyEvent::IRC
34 - Pod::POM >= v0.17 42 - Pod::POM
35 - Safe::Hole >= v0.10 43 - Safe::Hole
36 - Storable >= v2.0 44 - Storable
37 - Time::HiRes >= v1.0 45 - Time::HiRes
46 - URI
47 - YAML
38 - YAML::Syck >= v0.71 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.
39 53
40 Furthermore, you will need the following programs and libraries: 54 Furthermore, you will need the following programs and libraries:
41 55
42 - gperf, the GNU perfect hash generator >= v3.0 56 - gperf, the GNU perfect hash generator >= v3.0
43 - glib-2.0 >= v2.10 57 - glib-2.0 >= v2.10
44 - libpng >= v1.2 58 - libpng >= v1.2
45 - ImageMagick >= v6.0 59 - ImageMagick >= v6.0 (possibly higher, depending on its bugs)
46 - optipng => v0.5.5 (http://optipng.sf.net) 60 - optipng => v0.5.5 (http://optipng.sf.net)
47 - pngnq >= 0.4 (http://freshmeat.net/redir/pngnq/53146/url_homepage/pngnq.html) 61 - pngnq >= v0.4 (http://freshmeat.net/redir/pngnq/53146/url_homepage/pngnq.html)
48 - rsync >= 2.6 (a must have anyways) 62 - rsync >= v2.6 (a must have anyways)
49 63
50 Your compiler must support the Library Technical Report 1 extensions and 64 Your compiler must support the Library Technical Report 1 extensions and
51 the upcoming typeof extension. The GNU C++ compiler >= version 4.0 does 65 the upcoming typeof extension. The GNU C++ compiler >= version 4.0 does
52 support all these. 66 support all these.
53 67
55 above dependencies: 69 above dependencies:
56 70
57 apt-get install gperf optipng pngnq rsync imagemagick libglib2.0-dev libpng12-dev 71 apt-get install gperf optipng pngnq rsync imagemagick libglib2.0-dev libpng12-dev
58 apt-get install libpod-pom-perl libsafe-hole-perl libevent-perl 72 apt-get install libpod-pom-perl libsafe-hole-perl libevent-perl
59 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
60 78
61COMPILING 79COMPILING
62 80
63 Crossfire has been known to compile on a wide variety of systems. It should 81 Deliantra has been known to compile on a wide variety of systems. It should
64 compile and run on most ISO C++ 200x and POSIX compliant systems. 82 compile and run on most ISO C++ 200x and POSIX compliant systems.
65 83
66 To get generic directions on compilation, read the INSTALL file. 84 To get generic directions on compilation, read the INSTALL file.
67 85
68 86
69INSTALLATION/USAGE 87INSTALLATION/USAGE
70 88
71 Crossfire runs on a client/server model. You will also a client to 89 Deliantra runs on a client/server model. You will also a client to
72 play. You can either connect to a server someone else has set up, or 90 play. You can either connect to a server someone else has set up, or
73 run your own server and connect to that. There are a number of clients 91 run your own server and connect to that. There are a number of clients
74 available, but the recommended one is CFPlus (see below for URL). 92 available, but the recommended one is CFPlus (see below for URL).
75 93
76 To run your own server, you need to make the crossfire binaries and 94 To run your own server, you need to build the deliantra server binaries
77 install them, and then run the crossfire program. This now creates a 95 and install them, then you will have to download and install map and
78 server which you/other people can connect to. First you have to download 96 archetype packs:
79 and install maps and archetype packs, though.
80 97
81 Download both the cfmaps-<version> and cfarch-<version> archives, then use cfutil 98 Download both the cfmaps-<version> and cfarch-<version> archives, then
82 to install both: 99 use cfutil to install both (the source directories must be writable for
100 this to work):
83 101
84 cfutil --install-maps path/to/cfmaps-<version>/ 102 cfutil --install-maps path/to/cfmaps-<version>/
85 cfutil --install-arch path/to/cfarch-<version>/ 103 cfutil --install-arch path/to/cfarch-<version>/
86 104
87 Both processes can take some time, depending on your resources :) 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.
88 115
89 116
90WEB SITES: 117WEB SITES
91 118
92 The following web addresses have crossfire information that you may find 119 The following web addresses have deliantra information that you may find
93 useful: 120 useful:
94 121
95 http://crossfire.schmorp.de/ (The main site) 122 http://www.deliantra.net/ (The main site)
96
97 http://crossfire.real-time.com/ (The website for the old Crossfire game)
98 123
99 124
100REPORTING BUGS 125REPORTING BUGS
101 126
102 First, check the INSTALL file for common problems, and see if yours is 127 First, check the INSTALL file for common problems, and see if yours is
103 mentioned. 128 mentioned.
104 129
105 Bugs should be filed using the following email address: 130 Bugs should be filed using the following email address:
106 crossfire@schmorp.de 131 support@deliantra.net
107 132
108 When reporting bugs, make sure you include the following: 133 When reporting bugs, make sure you include the following:
134
109 o What version of crossfire did you use? 135 * What version of deliantra did you use?
110 o What type of computer did you use (CPU type) 136 * What type of computer did you use (CPU type)
111 o What is the version of the OS? 137 * What is the version of the OS?
112 o What windowing system are you using (e.g. openwindows, X.org, XFree86) 138 * What windowing system are you using (e.g. openwindows, X.org, XFree86)
113 o What compiler (and its version) did you use (e.g. gcc, acc)? 139 * What compiler (and its version) did you use (e.g. gcc, acc)?
114 o Which flags did you give it? 140 * Which flags did you give it?
115 o If the bug happens when compiling crossfire, send an EXACT copy of the 141 * If the bug happens when compiling deliantra, send an EXACT copy of the
116 compiler line, as well as the errors it puts out. Sending bugs of the 142 compiler line, as well as the errors it puts out. Sending bugs of the
117 sort 'it failed with a line like ...' doesn't help any. 143 sort 'it failed with a line like ...' doesn't help any.
118 o If the bug happened while running crossfire: 144 * If the bug happened while running deliantra:
119 - Include any output before to the bug. 145 - Include any output before to the bug.
120 - Give a description of what you did before the bug occured. The better 146 - Give a description of what you did before the bug occured. The better
121 detailed the description, the better chance I have of figuring 147 detailed the description, the better chance we have of figuring
122 out where the bug happened, or how I can recreate the bug. 148 out where the bug happened, or how we can recreate the bug.
123 - If possible, a stack trace from gdb (or other debugger) is very 149 - If possible, a stack trace from gdb (or other debugger) is very
124 helpful. 150 helpful.
125 151
126The more information provided, the better chance of the bug being fixed in 152 The more information provided, the better chance of the bug being fixed
127a timely fashion. 153 in a timely fashion.
128 154
129SUBMITTING PATCHES:
130 155
131 Patches should be submitted to email address: 156SUBMITTING PATCHES
132 crossfire@schmorp.de
133 157
134PUBLIC SERVERS: 158 Patches should be submitted to email address:
159 support@deliantra.net
135 160
136 The best way to find a server to play is to run the client
137 and hit "Server List" in the setup dialog (this varies
138 depending on your client). You can also see a list at
139 http://crossfire.real-time.com/metaserver/.
140 161
162PUBLIC 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
141 The canonical server for use with Crossfire and CFPlus is 168 The canonical server for use with Deliantra and CFPlus is
142 crossfire.schmorp.de, port 13327 (default). 169 gameserver.deliantra.net, port 13327 (the default).
170
143 171
144COPYRIGHT 172COPYRIGHT
145 173
146 Copyright (C) 2007 Crossfire Development Team 174 Most files in this distribution are covered by the GNU General Public
147 Copyright (C) 2000, 2006 Mark Wedel 175 License, version 3 (COPYING.GPL), or any later version, with the
148 Copyright (C) 1992 Frank Tore Johansen 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.
149 181
150 This program is free software; you can redistribute it and/or modify
151 it under the terms of the GNU General Public License as published by
152 the Free Software Foundation; either version 2 of the License, or
153 (at your option) any later version.
154 182
155 This program is distributed in the hope that it will be useful, 183CONTACT
156 but WITHOUT ANY WARRANTY; without even the implied warranty of
157 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
158 GNU General Public License for more details.
159 184
160 You should have received a copy of the GNU General Public License 185 The authors can be reached via e-mail to support@deliantra.net
161 along with this program; if not, write to the Free Software
162 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
163 186
164 The authors can be reached via e-mail to crossfire@schmorp.de

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines