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.34 by elmex, Sun Dec 2 10:18:12 2007 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 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
27 - AnyEvent >= v2.6
28 - BDB >= v1.1 **libdb4.5, libdb4.4 might work**
29 - Compress::LZF >= v1.8
30 - Coro >= v4.13 **SEE IMPORTANT NOTICE BELOW**
31 - Coro::EV >= v2.1
25 - Crossfire >= v0.97 32 - Crossfire >= v0.99
26 - Coro >= v3.5 33 - Digest::MD5 >= v2.0
27 - Coro::Event >= v2.1 34 - EV >= v0.9
28 - Event >= v1.08
29 - IO::AIO >= 2.32 35 - IO::AIO >= v2.51
30 - BDB >= v0.1 36 - JSON::XS >= v1.5
37 - Net::IRC3 => v0.5
38 - Pod::POM >= v0.17
39 - Safe::Hole >= v0.10
31 - Storable >= v2.0 40 - Storable >= v2.0
32 - Time::HiRes >= v1.0 41 - Time::HiRes >= v1.0
42 - URI >= 1.35
43 - YAML >= v0.62
33 - YAML::Syck >= v0.71 44 - YAML::Syck >= v0.71
34 - Digest::MD5 >= v2.0 45
35 - Compress::LZF >= v1.71 46 **NOTICE**: Deliantra uses an alternative signal stack, so you have to
36 - Safe::Hole >= v0.10 47 use either the "u"context method (slow) or "a"ssembly when configuring Coro.
37 - Pod::POM >= v0.17
38 48
39 Furthermore, you will need the following programs and libraries: 49 Furthermore, you will need the following programs and libraries:
40 50
41 - gperf, the GNU perfect hash generator >= v3.0 51 - gperf, the GNU perfect hash generator >= v3.0
42 - glib-2.0 >= v2.10 52 - glib-2.0 >= v2.10
43 - libpng >= v1.2 53 - libpng >= v1.2
44 - ImageMagick >= v6.0 54 - ImageMagick >= v6.0 (possibly higher, depending on its bugs)
45 - optipng => v0.5.5 (http://optipng.sf.net) 55 - optipng => v0.5.5 (http://optipng.sf.net)
56 - pngnq >= v0.4 (http://freshmeat.net/redir/pngnq/53146/url_homepage/pngnq.html)
46 - rsync >= 2.6 (a must have anyways) 57 - rsync >= v2.6 (a must have anyways)
47 58
48 Your compiler must support the Library Technical Report 1 extensions and 59 Your compiler must support the Library Technical Report 1 extensions and
49 the upcoming typeof extension. The GNU C++ compiler >= version 4.0 does 60 the upcoming typeof extension. The GNU C++ compiler >= version 4.0 does
50 support all these. 61 support all these.
51 62
63 On Debian GNU/Linux, you might get away with something like this for many of the
64 above dependencies:
65
66 apt-get install gperf optipng pngnq rsync imagemagick libglib2.0-dev libpng12-dev
67 apt-get install libpod-pom-perl libsafe-hole-perl libevent-perl
68
69 If you want to get sensible backtraces for error conditions at runtime
70 to be logged you also need the external addr2line program (part of GNU
71 binutils) in your PATH.
72
52 73
53COMPILING 74COMPILING
54 75
55 Crossfire has been known to compile on a wide variety of systems. It should 76 Deliantra has been known to compile on a wide variety of systems. It should
56 compile and run on most ISO C++ 200x and POSIX compliant systems. 77 compile and run on most ISO C++ 200x and POSIX compliant systems.
57 78
58 To get generic directions on compilation, read the INSTALL file. 79 To get generic directions on compilation, read the INSTALL file.
59 80
60 81
61INSTALLATION/USAGE 82INSTALLATION/USAGE
62 83
63 Crossfire runs on a client/server model. You will also a client to 84 Deliantra 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 85 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 86 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). 87 available, but the recommended one is CFPlus (see below for URL).
67 88
68 To run your own server, you need to make the crossfire binaries and 89 To run your own server, you need to build the deliantra server binaries
69 install them, and then run the crossfire program. This now creates a 90 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 91 archetype packs:
71 and install maps and archetype packs, though.
72 92
73 Download both the cfmaps-<version> and cfarch-<version> archives, then use cfutil 93 Download both the cfmaps-<version> and cfarch-<version> archives, then
74 to install both: 94 use cfutil to install both (the source directories must be writable for
95 this to work):
75 96
76 cfutil --install-maps path/to/cfmaps-<version>/ 97 cfutil --install-maps path/to/cfmaps-<version>/
77 cfutil --install-arch path/to/cfarch-<version>/ 98 cfutil --install-arch path/to/cfarch-<version>/
78 99
79 Both processes can take some time, depending on your resources :) 100 Both processes can take some time, depending on your resources :) If you
101 plan to repeat the installation you should specify the --cache option
102 first, which will keep costly-to-generate files around for further runs
103 of cfutil:
104
105 cfutil --cache --install-maps path/to/cfmaps-<version>/
106 cfutil --cache --install-arch path/to/cfarch-<version>/
107
108 Atfer this you can then run the deliantra executable. This starts a
109 server which you/other people can connect to.
80 110
81 111
82WEB SITES: 112WEB SITES
83 113
84 The following web addresses have crossfire information that you may find 114 The following web addresses have deliantra information that you may find
85 useful: 115 useful:
86 116
87 http://crossfire.schmorp.de/ (The main site) 117 http://www.deliantra.net/ (The main site)
88
89 http://crossfire.real-time.com/ (The website for the old Crossfire game)
90 118
91 119
92REPORTING BUGS 120REPORTING BUGS
93 121
94 First, check the INSTALL file for common problems, and see if yours is 122 First, check the INSTALL file for common problems, and see if yours is
95 mentioned. 123 mentioned.
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 support@deliantra.net
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 deliantra 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 deliantra, 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 deliantra:
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 support@deliantra.net
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).
162
133 The canonical server for use with Crossfire and CFPlus is 163 The canonical server for use with Deliantra and CFPlus is
134 crossfire.schmorp.de, port 13327 (default). 164 gameserver.deliantra.net, port 13327 (the default).
165
135 166
136COPYRIGHT 167COPYRIGHT
137 168
138 Copyright (C) 2007 Crossfire Development Team 169 Most files in this distribution are covered by the GNU General Public
139 Copyright (C) 2000, 2006 Mark Wedel 170 License, version 3 (COPYING.GPL), or any later version, with the
140 Copyright (C) 1992 Frank Tore Johansen 171 exception of ext/affero.ext, which is covered by the GNU Affero General
172 Public License, Version 3 (COPYING.Affero). Please take note of the
173 special requirements of the Affero license with respect to network
174 servers and configure your network server according to the instructions
175 given in ext/affero.ext.
141 176
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 177
147 This program is distributed in the hope that it will be useful, 178CONTACT
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 179
152 You should have received a copy of the GNU General Public License 180 The authors can be reached via e-mail to support@deliantra.net
153 along with this program; if not, write to the Free Software
154 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
155 181
156 The authors can be reached via e-mail to crossfire@schmorp.de

Diff Legend

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