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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines