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.53 by root, Sat Apr 23 04:46:25 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
59 - blitz++ >= 0.9
50 - glib-2.0 >= v2.10 60 - glib-2.0 >= v2.10
51 - libpng >= v1.2 61 - libpng >= v1.2
52 - ImageMagick >= v6.0 (possibly higher, depending on its bugs) 62 - ImageMagick >= v6.0 (possibly higher, depending on its bugs)
53 - optipng => v0.5.5 (http://optipng.sf.net) 63 - optipng => v0.5.5 (http://optipng.sf.net)
54 - pngnq >= v0.4 (http://freshmeat.net/redir/pngnq/53146/url_homepage/pngnq.html) 64 - pngnq >= v0.4 (http://freshmeat.net/redir/pngnq/53146/url_homepage/pngnq.html)
69 binutils) in your PATH. 79 binutils) in your PATH.
70 80
71 81
72COMPILING 82COMPILING
73 83
74 Crossfire has been known to compile on a wide variety of systems. It should 84 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. 85 compile and run on most ISO C++ 200x and POSIX compliant systems.
76 86
77 To get generic directions on compilation, read the INSTALL file. 87 To get generic directions on compilation, read the INSTALL file.
78 88
79 89
80INSTALLATION/USAGE 90INSTALLATION/USAGE
81 91
82 Crossfire runs on a client/server model. You will also a client to 92 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 93 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 94 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). 95 available, the recommended one is the Deliantra Client (see below for URL).
86 96
87 To run your own server, you need to build the crossfire server binaries 97 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 98 and install them, then you will have to download and install map and
89 archetype packs: 99 archetype packs:
90 100
91 Download both the cfmaps-<version> and cfarch-<version> archives, then 101 Download both the cfmaps-<version> and cfarch-<version> archives, then
92 use cfutil to install both (the source directories must be writable for 102 use cfutil to install both (the source directories must be writable for
95 cfutil --install-maps path/to/cfmaps-<version>/ 105 cfutil --install-maps path/to/cfmaps-<version>/
96 cfutil --install-arch path/to/cfarch-<version>/ 106 cfutil --install-arch path/to/cfarch-<version>/
97 107
98 Both processes can take some time, depending on your resources :) If you 108 Both processes can take some time, depending on your resources :) If you
99 plan to repeat the installation you should specify the --cache option 109 plan to repeat the installation you should specify the --cache option
100 which will keep costly-to-generate files around for further runs of 110 first, which will keep costly-to-generate files around for further runs
101 cfutil. 111 of cfutil:
102 112
113 cfutil --cache --install-maps path/to/cfmaps-<version>/
114 cfutil --cache --install-arch path/to/cfarch-<version>/
115
103 Atfer this you can then run the crossfire executable. This starts a 116 Atfer this you can then run the deliantra executable. This starts a
104 server which you/other people can connect to. 117 server which you/other people can connect to.
105 118
106 119
107WEB SITES 120WEB SITES
108 121
109 The following web addresses have crossfire information that you may find 122 The following web addresses have deliantra information that you may find
110 useful: 123 useful:
111 124
112 http://crossfire.schmorp.de/ (The main site) 125 http://www.deliantra.net/ (The main site)
113
114 http://crossfire.real-time.com/ (The website for the old Crossfire game)
115 126
116 127
117REPORTING BUGS 128REPORTING BUGS
118 129
119 First, check the INSTALL file for common problems, and see if yours is 130 First, check the INSTALL file for common problems, and see if yours is
120 mentioned. 131 mentioned.
121 132
122 Bugs should be filed using the following email address: 133 Bugs should be filed using the following email address:
123 crossfire@schmorp.de 134 support@deliantra.net
124 135
125 When reporting bugs, make sure you include the following: 136 When reporting bugs, make sure you include the following:
126 137
127 * What version of crossfire did you use? 138 * What version of deliantra did you use?
128 * What type of computer did you use (CPU type) 139 * What type of computer did you use (CPU type)
129 * What is the version of the OS? 140 * What is the version of the OS?
130 * What windowing system are you using (e.g. openwindows, X.org, XFree86) 141 * 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)? 142 * What compiler (and its version) did you use (e.g. gcc, acc)?
132 * Which flags did you give it? 143 * Which flags did you give it?
133 * If the bug happens when compiling crossfire, send an EXACT copy of the 144 * 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 145 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. 146 sort 'it failed with a line like ...' doesn't help any.
136 * If the bug happened while running crossfire: 147 * If the bug happened while running deliantra:
137 - Include any output before to the bug. 148 - Include any output before to the bug.
138 - Give a description of what you did before the bug occured. The better 149 - Give a description of what you did before the bug occured. The better
139 detailed the description, the better chance we have of figuring 150 detailed the description, the better chance we have of figuring
140 out where the bug happened, or how we can recreate the bug. 151 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 152 - If possible, a stack trace from gdb (or other debugger) is very
146 157
147 158
148SUBMITTING PATCHES 159SUBMITTING PATCHES
149 160
150 Patches should be submitted to email address: 161 Patches should be submitted to email address:
151 crossfire@schmorp.de 162 support@deliantra.net
152 163
153 164
154PUBLIC SERVERS 165PUBLIC SERVERS
155 166
156 The best way to find a server to play is to run the client 167 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 168 and hit "Server List" in the setup dialog (this varies
158 depending on your client). You can also see a list at 169 depending on your client).
159 http://crossfire.real-time.com/metaserver/.
160 170
161 The canonical server for use with Crossfire and CFPlus is 171 The canonical server for use with Deliantra and CFPlus is
162 crossfire.schmorp.de, port 13327 (default). 172 gameserver.deliantra.net, port 13327 (the default).
163 173
164 174
165COPYRIGHT 175COPYRIGHT
166 176
167 Most files in this distribution are covered by the GNU General Public 177 Most files in this distribution are covered by the GNU General Public
173 given in ext/affero.ext. 183 given in ext/affero.ext.
174 184
175 185
176CONTACT 186CONTACT
177 187
178 The authors can be reached via e-mail to crossfire@schmorp.de 188 The authors can be reached via e-mail to support@deliantra.net
179 189

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines