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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines