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

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines