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

Comparing deliantra/server/README (file contents):
Revision 1.21 by root, Sat Aug 4 17:48:15 2007 UTC vs.
Revision 1.52 by root, Fri Apr 22 02:03:10 2011 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.1). 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
29 - common::sense
27 - AnyEvent >= v2.52 30 - AnyEvent
28 - BDB >= v0.1 **libdb4.5, libdb4.4 might work** 31 - AnyEvent::AIO
32 - AnyEvent::BDB
33 - BDB **compiled against libdb4.[567] (libdb4.4 *might* work)**
29 - Compress::LZF >= v1.8 34 - Compress::LZF
30 - Coro >= v3.62 **SEE IMPORTANT NOTICE BELOW** 35 - Coro **SEE IMPORTANT NOTICE BELOW**
31 - Coro::Event >= v2.1 36 - Coro::EV
32 - Crossfire >= v0.99 37 - Deliantra
33 - Digest::MD5 >= v2.0 38 - Digest::MD5
34 - Event >= v1.08 39 - EV
40 - Guard
35 - IO::AIO >= v2.4 41 - IO::AIO
36 - JSON::XS => v1.41 42 - JSON::XS
43 - AnyEvent::IRC
37 - Pod::POM >= v0.17 44 - Pod::POM
38 - Safe::Hole >= v0.10 45 - Safe::Hole
39 - Storable >= v2.0 46 - Storable
40 - Time::HiRes >= v1.0 47 - Time::HiRes
41 - YAML::Syck >= v0.71 48 - URI
42 - YAML => v0.62 49 - YAML::XS
43 50
44 **NOTICE**: Crossfire uses an alternative signal stack, so you have to 51 **NOTICE**: Deliantra uses an alternative signal stack, so you cannot
45 use either the "u"context method (slow) or "a"ssembly when configuring Coro. 52 use the sigaltstack method (== setjmp on unrecognised platforms) for
53 Coro. Try "a"ssembly, "u"context or "p"threads as backend instead on
54 those platforms.
46 55
47 Furthermore, you will need the following programs and libraries: 56 Furthermore, you will need the following programs and libraries:
48 57
49 - gperf, the GNU perfect hash generator >= v3.0 58 - gperf, the GNU perfect hash generator >= v3.0
50 - glib-2.0 >= v2.10 59 - glib-2.0 >= v2.10
69 binutils) in your PATH. 78 binutils) in your PATH.
70 79
71 80
72COMPILING 81COMPILING
73 82
74 Crossfire has been known to compile on a wide variety of systems. It should 83 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. 84 compile and run on most ISO C++ 200x and POSIX compliant systems.
76 85
77 To get generic directions on compilation, read the INSTALL file. 86 To get generic directions on compilation, read the INSTALL file.
78 87
79 88
80INSTALLATION/USAGE 89INSTALLATION/USAGE
81 90
82 Crossfire runs on a client/server model. You will also a client to 91 Deliantra runs on a client/server model. You will also need a client to
83 play. You can either connect to a server someone else has set up, or 92 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 93 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). 94 available, the recommended one is the Deliantra Client (see below for URL).
86 95
87 To run your own server, you need to build the crossfire server binaries 96 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 97 and install them, then you will have to download and install map and
89 archetype packs: 98 archetype packs:
90 99
91 Download both the cfmaps-<version> and cfarch-<version> archives, then 100 Download both the cfmaps-<version> and cfarch-<version> archives, then
92 use cfutil to install both (the source directories must be writable for 101 use cfutil to install both (the source directories must be writable for
95 cfutil --install-maps path/to/cfmaps-<version>/ 104 cfutil --install-maps path/to/cfmaps-<version>/
96 cfutil --install-arch path/to/cfarch-<version>/ 105 cfutil --install-arch path/to/cfarch-<version>/
97 106
98 Both processes can take some time, depending on your resources :) If you 107 Both processes can take some time, depending on your resources :) If you
99 plan to repeat the installation you should specify the --cache option 108 plan to repeat the installation you should specify the --cache option
100 which will keep costly-to-generate files around for further runs of 109 first, which will keep costly-to-generate files around for further runs
101 cfutil. 110 of cfutil:
102 111
112 cfutil --cache --install-maps path/to/cfmaps-<version>/
113 cfutil --cache --install-arch path/to/cfarch-<version>/
114
103 Atfer this you can then run the crossfire executable. This starts a 115 Atfer this you can then run the deliantra executable. This starts a
104 server which you/other people can connect to. 116 server which you/other people can connect to.
105 117
106 118
107WEB SITES 119WEB SITES
108 120
109 The following web addresses have crossfire information that you may find 121 The following web addresses have deliantra information that you may find
110 useful: 122 useful:
111 123
112 http://crossfire.schmorp.de/ (The main site) 124 http://www.deliantra.net/ (The main site)
113
114 http://crossfire.real-time.com/ (The website for the old Crossfire game)
115 125
116 126
117REPORTING BUGS 127REPORTING BUGS
118 128
119 First, check the INSTALL file for common problems, and see if yours is 129 First, check the INSTALL file for common problems, and see if yours is
120 mentioned. 130 mentioned.
121 131
122 Bugs should be filed using the following email address: 132 Bugs should be filed using the following email address:
123 crossfire@schmorp.de 133 support@deliantra.net
124 134
125 When reporting bugs, make sure you include the following: 135 When reporting bugs, make sure you include the following:
126 136
127 * What version of crossfire did you use? 137 * What version of deliantra did you use?
128 * What type of computer did you use (CPU type) 138 * What type of computer did you use (CPU type)
129 * What is the version of the OS? 139 * What is the version of the OS?
130 * What windowing system are you using (e.g. openwindows, X.org, XFree86) 140 * What windowing system are you using (e.g. openwindows, X.org, XFree86)
131 * What compiler (and its version) did you use (e.g. gcc, acc)? 141 * What compiler (and its version) did you use (e.g. gcc, acc)?
132 * Which flags did you give it? 142 * Which flags did you give it?
133 * If the bug happens when compiling crossfire, send an EXACT copy of the 143 * If the bug happens when compiling deliantra, send an EXACT copy of the
134 compiler line, as well as the errors it puts out. Sending bugs of the 144 compiler line, as well as the errors it puts out. Sending bugs of the
135 sort 'it failed with a line like ...' doesn't help any. 145 sort 'it failed with a line like ...' doesn't help any.
136 * If the bug happened while running crossfire: 146 * If the bug happened while running deliantra:
137 - Include any output before to the bug. 147 - Include any output before to the bug.
138 - Give a description of what you did before the bug occured. The better 148 - Give a description of what you did before the bug occured. The better
139 detailed the description, the better chance we have of figuring 149 detailed the description, the better chance we have of figuring
140 out where the bug happened, or how we can recreate the bug. 150 out where the bug happened, or how we can recreate the bug.
141 - If possible, a stack trace from gdb (or other debugger) is very 151 - If possible, a stack trace from gdb (or other debugger) is very
146 156
147 157
148SUBMITTING PATCHES 158SUBMITTING PATCHES
149 159
150 Patches should be submitted to email address: 160 Patches should be submitted to email address:
151 crossfire@schmorp.de 161 support@deliantra.net
152 162
153 163
154PUBLIC SERVERS 164PUBLIC SERVERS
155 165
156 The best way to find a server to play is to run the client 166 The best way to find a server to play is to run the client
157 and hit "Server List" in the setup dialog (this varies 167 and hit "Server List" in the setup dialog (this varies
158 depending on your client). You can also see a list at 168 depending on your client).
159 http://crossfire.real-time.com/metaserver/.
160 169
161 The canonical server for use with Crossfire and CFPlus is 170 The canonical server for use with Deliantra and CFPlus is
162 crossfire.schmorp.de, port 13327 (default). 171 gameserver.deliantra.net, port 13327 (the default).
163 172
164 173
165COPYRIGHT 174COPYRIGHT
166 175
167 Most files in this distribution are covered by the GNU General Public 176 Most files in this distribution are covered by the GNU General Public
173 given in ext/affero.ext. 182 given in ext/affero.ext.
174 183
175 184
176CONTACT 185CONTACT
177 186
178 The authors can be reached via e-mail to crossfire@schmorp.de 187 The authors can be reached via e-mail to support@deliantra.net
179 188

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines