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

Comparing deliantra/server/README (file contents):
Revision 1.11 by root, Wed May 2 05:47:35 2007 UTC vs.
Revision 1.26 by root, Thu Sep 13 16:16:00 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines