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

Comparing deliantra/server/README (file contents):
Revision 1.28 by root, Sun Oct 7 15:52:04 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 >= v2.52 27 - AnyEvent
28 - BDB >= v1.1 **libdb4.5, libdb4.4 might work** 28 - BDB **compiled against libdb4.[56] (libdb4.4 *might* work)**
29 - Compress::LZF >= v1.8 29 - Compress::LZF
30 - Coro >= v4.01 **SEE IMPORTANT NOTICE BELOW** 30 - Coro **SEE IMPORTANT NOTICE BELOW**
31 - Coro::Event >= v2.1 31 - Coro::EV
32 - Crossfire >= v0.99 32 - Deliantra
33 - Digest::MD5 >= v2.0 33 - Digest::MD5
34 - Event >= v1.08 34 - EV
35 - IO::AIO >= v2.4 35 - IO::AIO
36 - JSON::XS >= v1.5 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
41 - URI >= 1.35 42 - URI
42 - YAML >= v0.62 43 - YAML
43 - YAML::Syck >= v0.71 44 - YAML::Syck
44 45
45 **NOTICE**: Crossfire uses an alternative signal stack, so you have to 46 **NOTICE**: Deliantra uses an alternative signal stack, so you have to
46 use either the "u"context method (slow) or "a"ssembly when configuring Coro. 47 use either the "u"context method (slow) or "a"ssembly when configuring
48 Coro.
47 49
48 Furthermore, you will need the following programs and libraries: 50 Furthermore, you will need the following programs and libraries:
49 51
50 - gperf, the GNU perfect hash generator >= v3.0 52 - gperf, the GNU perfect hash generator >= v3.0
51 - glib-2.0 >= v2.10 53 - glib-2.0 >= v2.10
70 binutils) in your PATH. 72 binutils) in your PATH.
71 73
72 74
73COMPILING 75COMPILING
74 76
75 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
76 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.
77 79
78 To get generic directions on compilation, read the INSTALL file. 80 To get generic directions on compilation, read the INSTALL file.
79 81
80 82
81INSTALLATION/USAGE 83INSTALLATION/USAGE
82 84
83 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
84 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
85 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
86 available, but the recommended one is CFPlus (see below for URL). 88 available, but the recommended one is CFPlus (see below for URL).
87 89
88 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
89 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
90 archetype packs: 92 archetype packs:
91 93
92 Download both the cfmaps-<version> and cfarch-<version> archives, then 94 Download both the cfmaps-<version> and cfarch-<version> archives, then
93 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
102 of cfutil: 104 of cfutil:
103 105
104 cfutil --cache --install-maps path/to/cfmaps-<version>/ 106 cfutil --cache --install-maps path/to/cfmaps-<version>/
105 cfutil --cache --install-arch path/to/cfarch-<version>/ 107 cfutil --cache --install-arch path/to/cfarch-<version>/
106 108
107 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
108 server which you/other people can connect to. 110 server which you/other people can connect to.
109 111
110 112
111WEB SITES 113WEB SITES
112 114
113 The following web addresses have crossfire information that you may find 115 The following web addresses have deliantra information that you may find
114 useful: 116 useful:
115 117
116 http://crossfire.schmorp.de/ (The main site) 118 http://www.deliantra.net/ (The main site)
117
118 http://crossfire.real-time.com/ (The website for the old Crossfire game)
119 119
120 120
121REPORTING BUGS 121REPORTING BUGS
122 122
123 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
124 mentioned. 124 mentioned.
125 125
126 Bugs should be filed using the following email address: 126 Bugs should be filed using the following email address:
127 crossfire@schmorp.de 127 support@deliantra.net
128 128
129 When reporting bugs, make sure you include the following: 129 When reporting bugs, make sure you include the following:
130 130
131 * What version of crossfire did you use? 131 * What version of deliantra did you use?
132 * What type of computer did you use (CPU type) 132 * What type of computer did you use (CPU type)
133 * What is the version of the OS? 133 * What is the version of the OS?
134 * 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)
135 * 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)?
136 * Which flags did you give it? 136 * Which flags did you give it?
137 * 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
138 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
139 sort 'it failed with a line like ...' doesn't help any. 139 sort 'it failed with a line like ...' doesn't help any.
140 * If the bug happened while running crossfire: 140 * If the bug happened while running deliantra:
141 - Include any output before to the bug. 141 - Include any output before to the bug.
142 - 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
143 detailed the description, the better chance we have of figuring 143 detailed the description, the better chance we have of figuring
144 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.
145 - 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
150 150
151 151
152SUBMITTING PATCHES 152SUBMITTING PATCHES
153 153
154 Patches should be submitted to email address: 154 Patches should be submitted to email address:
155 crossfire@schmorp.de 155 support@deliantra.net
156 156
157 157
158PUBLIC SERVERS 158PUBLIC SERVERS
159 159
160 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
161 and hit "Server List" in the setup dialog (this varies 161 and hit "Server List" in the setup dialog (this varies
162 depending on your client). You can also see a list at 162 depending on your client).
163 http://crossfire.real-time.com/metaserver/.
164 163
165 The canonical server for use with Crossfire and CFPlus is 164 The canonical server for use with Deliantra and CFPlus is
166 crossfire.schmorp.de, port 13327 (default). 165 gameserver.deliantra.net, port 13327 (the default).
167 166
168 167
169COPYRIGHT 168COPYRIGHT
170 169
171 Most files in this distribution are covered by the GNU General Public 170 Most files in this distribution are covered by the GNU General Public
177 given in ext/affero.ext. 176 given in ext/affero.ext.
178 177
179 178
180CONTACT 179CONTACT
181 180
182 The authors can be reached via e-mail to crossfire@schmorp.de 181 The authors can be reached via e-mail to support@deliantra.net
183 182

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines