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

Comparing deliantra/server/README (file contents):
Revision 1.23 by root, Sat Aug 18 17:33:53 2007 UTC vs.
Revision 1.45 by root, Sat Aug 30 05:19:03 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 requires perl 5.10). A perl configured for 64 bit integer support is
24 minimum versions below may not be up-to-date, the configure script will 24 highly recommended to avoid overflows, but 32 bit perls are supported)
25 check them all, though). 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.
26 28
27 - AnyEvent >= v2.52 29 - AnyEvent
28 - BDB >= v0.1 **libdb4.5, libdb4.4 might work** 30 - AnyEvent::AIO
31 - AnyEvent::BDB
32 - BDB **compiled against libdb4.[567] (libdb4.4 *might* work)**
29 - Compress::LZF >= v1.8 33 - Compress::LZF
30 - Coro >= v3.64 **SEE IMPORTANT NOTICE BELOW** 34 - Coro **SEE IMPORTANT NOTICE BELOW**
31 - Coro::Event >= v2.1 35 - Coro::EV
32 - Crossfire >= v0.99 36 - Deliantra
33 - Digest::MD5 >= v2.0 37 - Digest::MD5
34 - Event >= v1.08 38 - EV
35 - IO::AIO >= v2.4 39 - IO::AIO
36 - JSON::XS => v1.41 40 - JSON::XS
41 - Net::IRC3
37 - Pod::POM >= v0.17 42 - Pod::POM
38 - Safe::Hole >= v0.10 43 - Safe::Hole
39 - Storable >= v2.0 44 - Storable
40 - Time::HiRes >= v1.0 45 - Time::HiRes
46 - URI
47 - YAML
41 - YAML::Syck >= v0.71 48 - YAML::Syck
42 - YAML => v0.62
43 49
44 **NOTICE**: Crossfire uses an alternative signal stack, so you have to 50 **NOTICE**: Deliantra uses an alternative signal stack, so you have to
45 use either the "u"context method (slow) or "a"ssembly when configuring Coro. 51 use either the "u"context method (slow) or "a"ssembly when configuring
52 Coro.
46 53
47 Furthermore, you will need the following programs and libraries: 54 Furthermore, you will need the following programs and libraries:
48 55
49 - gperf, the GNU perfect hash generator >= v3.0 56 - gperf, the GNU perfect hash generator >= v3.0
50 - glib-2.0 >= v2.10 57 - glib-2.0 >= v2.10
69 binutils) in your PATH. 76 binutils) in your PATH.
70 77
71 78
72COMPILING 79COMPILING
73 80
74 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
75 compile and run on most ISO C++ 200x and POSIX compliant systems. 82 compile and run on most ISO C++ 200x and POSIX compliant systems.
76 83
77 To get generic directions on compilation, read the INSTALL file. 84 To get generic directions on compilation, read the INSTALL file.
78 85
79 86
80INSTALLATION/USAGE 87INSTALLATION/USAGE
81 88
82 Crossfire runs on a client/server model. You will also a client to 89 Deliantra runs on a client/server model. You will also a client to
83 play. You can either connect to a server someone else has set up, or 90 play. You can either connect to a server someone else has set up, or
84 run your own server and connect to that. There are a number of clients 91 run your own server and connect to that. There are a number of clients
85 available, but the recommended one is CFPlus (see below for URL). 92 available, but the recommended one is CFPlus (see below for URL).
86 93
87 To run your own server, you need to build the crossfire server binaries 94 To run your own server, you need to build the deliantra server binaries
88 and install them, then you will have to download and install map and 95 and install them, then you will have to download and install map and
89 archetype packs: 96 archetype packs:
90 97
91 Download both the cfmaps-<version> and cfarch-<version> archives, then 98 Download both the cfmaps-<version> and cfarch-<version> archives, then
92 use cfutil to install both (the source directories must be writable for 99 use cfutil to install both (the source directories must be writable for
101 of cfutil: 108 of cfutil:
102 109
103 cfutil --cache --install-maps path/to/cfmaps-<version>/ 110 cfutil --cache --install-maps path/to/cfmaps-<version>/
104 cfutil --cache --install-arch path/to/cfarch-<version>/ 111 cfutil --cache --install-arch path/to/cfarch-<version>/
105 112
106 Atfer this you can then run the crossfire executable. This starts a 113 Atfer this you can then run the deliantra executable. This starts a
107 server which you/other people can connect to. 114 server which you/other people can connect to.
108 115
109 116
110WEB SITES 117WEB SITES
111 118
112 The following web addresses have crossfire information that you may find 119 The following web addresses have deliantra information that you may find
113 useful: 120 useful:
114 121
115 http://crossfire.schmorp.de/ (The main site) 122 http://www.deliantra.net/ (The main site)
116
117 http://crossfire.real-time.com/ (The website for the old Crossfire game)
118 123
119 124
120REPORTING BUGS 125REPORTING BUGS
121 126
122 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
123 mentioned. 128 mentioned.
124 129
125 Bugs should be filed using the following email address: 130 Bugs should be filed using the following email address:
126 crossfire@schmorp.de 131 support@deliantra.net
127 132
128 When reporting bugs, make sure you include the following: 133 When reporting bugs, make sure you include the following:
129 134
130 * What version of crossfire did you use? 135 * What version of deliantra did you use?
131 * What type of computer did you use (CPU type) 136 * What type of computer did you use (CPU type)
132 * What is the version of the OS? 137 * What is the version of the OS?
133 * 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)
134 * 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)?
135 * Which flags did you give it? 140 * Which flags did you give it?
136 * 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
137 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
138 sort 'it failed with a line like ...' doesn't help any. 143 sort 'it failed with a line like ...' doesn't help any.
139 * If the bug happened while running crossfire: 144 * If the bug happened while running deliantra:
140 - Include any output before to the bug. 145 - Include any output before to the bug.
141 - 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
142 detailed the description, the better chance we have of figuring 147 detailed the description, the better chance we have of figuring
143 out where the bug happened, or how we can recreate the bug. 148 out where the bug happened, or how we can recreate the bug.
144 - 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
149 154
150 155
151SUBMITTING PATCHES 156SUBMITTING PATCHES
152 157
153 Patches should be submitted to email address: 158 Patches should be submitted to email address:
154 crossfire@schmorp.de 159 support@deliantra.net
155 160
156 161
157PUBLIC SERVERS 162PUBLIC SERVERS
158 163
159 The best way to find a server to play is to run the client 164 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 165 and hit "Server List" in the setup dialog (this varies
161 depending on your client). You can also see a list at 166 depending on your client).
162 http://crossfire.real-time.com/metaserver/.
163 167
164 The canonical server for use with Crossfire and CFPlus is 168 The canonical server for use with Deliantra and CFPlus is
165 crossfire.schmorp.de, port 13327 (default). 169 gameserver.deliantra.net, port 13327 (the default).
166 170
167 171
168COPYRIGHT 172COPYRIGHT
169 173
170 Most files in this distribution are covered by the GNU General Public 174 Most files in this distribution are covered by the GNU General Public
176 given in ext/affero.ext. 180 given in ext/affero.ext.
177 181
178 182
179CONTACT 183CONTACT
180 184
181 The authors can be reached via e-mail to crossfire@schmorp.de 185 The authors can be reached via e-mail to support@deliantra.net
182 186

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines