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

Comparing deliantra/server/README (file contents):
Revision 1.5 by root, Mon Mar 5 22:06:50 2007 UTC vs.
Revision 1.48 by root, Mon Oct 12 14:00:57 2009 UTC

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

Diff Legend

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