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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines