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

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

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines