| 1 | WHAT IS CROSSFIRE? |
1 | WHAT IS DELIANTRA? |
| 2 | |
2 | |
| 3 | This is a multiplayer graphical arcade and adventure game, that runs on a |
3 | This is a multiplayer graphical arcade and adventure game, that runs on |
| 4 | client/server model. There are clients for Microsoft(R) Windows(TM) and |
4 | a client/server model. There are clients for Microsoft(R) Windows(TM) |
| 5 | POSIX systems such as Linux and *BSD. To get the most joyful experience, |
5 | and POSIX systems such as Linux and *BSD. To get the most joyful |
| 6 | the Crossfire+ client should be used. This client is written in Perl and |
6 | experience, the Deliantra client should be used. This client is written |
| 7 | utilises SDL with OpenGL. |
7 | in Perl and utilises SDL with OpenGL to provide you with the most |
|
|
8 | immersive gameplay. |
| 8 | |
9 | |
| 9 | Crossfire has certain flavours from other games, especially Gauntlet (TM) |
10 | Deliantra has certain flavours from other games, especially Gauntlet (TM) |
| 10 | and Nethack/Moria. |
11 | and Nethack/Moria. |
| 11 | |
12 | |
| 12 | Any number of players can move around in their own window, finding |
13 | Any number of players can move around in their own window on the |
| 13 | and using items and battle monsters. They can choose to cooperate |
14 | world, finding and using items and battle monsters. They can choose to |
| 14 | or compete in the same "world". |
15 | cooperate or compete in the same "world". |
|
|
16 | |
| 15 | |
17 | |
| 16 | REQUIREMENTS |
18 | REQUIREMENTS |
| 17 | |
19 | |
| 18 | For UNIX, the ISO C++ 200x compiler are required to compile this game. In |
20 | For UNIX, a modern C++ compiler with some extensions is required to |
| 19 | addition, you will need the Perl development libraries along with the |
21 | compile this game (g++ 4.x works). In addition, you will need the Perl |
| 20 | following Perl modules: |
22 | development libraries along with the following Perl modules (the server |
|
|
23 | requires perl 5.10.1). A perl configured for 64 bit integer support is |
|
|
24 | highly recommended to avoid overflows, but 32 bit perls are supported) |
|
|
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. |
| 21 | |
28 | |
| 22 | - Crossfire >= v0.97 |
29 | - common::sense |
| 23 | - Coro >= v3.5 |
30 | - AnyEvent |
| 24 | - Coro::Event >= v2.1 |
31 | - AnyEvent::AIO |
| 25 | - Event >= v1.08 |
32 | - AnyEvent::BDB |
| 26 | - IO::AIO >= 2.32 |
33 | - BDB **compiled against libdb4.[567] (libdb4.4 *might* work)** |
| 27 | - BDB >= v0.1 |
34 | - Compress::LZF |
| 28 | - Storable >= v2.0 |
35 | - Coro **SEE IMPORTANT NOTICE BELOW** |
| 29 | - Time::HiRes >= v1.0 |
36 | - Coro::EV |
| 30 | - YAML::Syck >= v0.71 |
37 | - Deliantra |
| 31 | - Digest::MD5 >= v2.0 |
38 | - Digest::MD5 |
| 32 | - Compress::LZF >= v1.71 |
39 | - EV |
|
|
40 | - Guard |
|
|
41 | - IO::AIO |
|
|
42 | - JSON::XS |
|
|
43 | - AnyEvent::IRC |
|
|
44 | - Pod::POM |
| 33 | - Safe::Hole >= v0.10 |
45 | - Safe::Hole |
| 34 | - Pod::POM >= v0.17 |
46 | - Storable |
|
|
47 | - Time::HiRes |
|
|
48 | - URI |
|
|
49 | - YAML::XS |
| 35 | |
50 | |
| 36 | Furthermore, to build the crossfire server you will need the following: |
51 | **NOTICE**: Deliantra uses an alternative signal stack, so you cannot |
|
|
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. |
| 37 | |
55 | |
|
|
56 | Furthermore, you will need the following programs and libraries: |
|
|
57 | |
| 38 | - gperf, the GNU perfect hash generator |
58 | - gperf, the GNU perfect hash generator >= v3.0 |
|
|
59 | - blitz++ >= 0.9 |
| 39 | - glib-2.0 >= v2.10 |
60 | - glib-2.0 >= v2.10 |
| 40 | - libpng >= v1.2 |
61 | - libpng >= v1.2 |
|
|
62 | - ImageMagick >= v6.3 (possibly higher, depending on its bugs) |
|
|
63 | - optipng => v0.5.5 (http://optipng.sf.net) |
|
|
64 | - pngnq >= v0.4 (http://freshmeat.net/redir/pngnq/53146/url_homepage/pngnq.html) |
|
|
65 | - rsync >= v2.6 (a must have anyways) |
| 41 | |
66 | |
| 42 | Your compiler must support the Library Technical Report 1 extensions. |
67 | Your compiler must support the Library Technical Report 1 extensions and |
| 43 | The GNU C++ compiler >= version 4.0 does support these. |
68 | the upcoming typeof extension. The GNU C++ compiler >= version 4.0 does |
|
|
69 | support all these. |
|
|
70 | |
|
|
71 | On Debian GNU/Linux, you might get away with something like this for many of the |
|
|
72 | above dependencies: |
|
|
73 | |
|
|
74 | apt-get install gperf optipng pngnq rsync imagemagick libglib2.0-dev libpng12-dev |
|
|
75 | apt-get install libpod-pom-perl libsafe-hole-perl libevent-perl libblitz0-dev |
|
|
76 | |
|
|
77 | If you want to get sensible backtraces for error conditions at runtime |
|
|
78 | to be logged you also need the external addr2line program (part of GNU |
|
|
79 | binutils) in your PATH. |
|
|
80 | |
| 44 | |
81 | |
| 45 | COMPILING |
82 | COMPILING |
| 46 | |
83 | |
| 47 | 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 |
| 48 | compile and most all ISO C++ 200x and POSIX compliant systems. |
85 | compile and run on most ISO C++ 200x and POSIX compliant systems. |
| 49 | |
86 | |
| 50 | To get directions on compilation for UNIX/LINUX, read the INSTALL file. |
87 | To get generic directions on compilation, read the INSTALL file. |
| 51 | |
88 | |
| 52 | USAGE |
|
|
| 53 | |
89 | |
| 54 | Crossfire runs on a client/server model. You will also need the client to |
90 | INSTALLATION/USAGE |
| 55 | play. You can either connect to a server someone else has set up, or run |
|
|
| 56 | your own server and connect to that. The client package has information for |
|
|
| 57 | connecting to servers. |
|
|
| 58 | |
91 | |
| 59 | To run your own server, you need to make the crossfire binaries and install |
92 | Deliantra runs on a client/server model. You will also need a client to |
| 60 | them, and then run the crossfire program. This now creates a server which |
93 | play. You can either connect to a server someone else has set up, or |
| 61 | you/other people can connect to. The map files will need to get downloaded |
94 | run your own server and connect to that. There are a number of clients |
| 62 | and installed for the server to run properly. The maps should be unpacked in |
95 | available, the recommended one is the Deliantra Client (see below for URL). |
| 63 | the $(TARGET)/share/crossfire directory - after unpacking, you should have a |
|
|
| 64 | $(TARGET)/share/crossfire/maps directory. |
|
|
| 65 | |
96 | |
| 66 | If you plan to run a long term server, you should use one of the scripts |
97 | To run your own server, you need to build the deliantra server binaries |
| 67 | provided that will re-run crossfire if it dies for some reason. |
98 | and install them, then you will have to download and install map and |
|
|
99 | archetype packs: |
| 68 | |
100 | |
| 69 | WEB SITES: |
101 | Download both the cfmaps-<version> and cfarch-<version> archives, then |
|
|
102 | use cfutil to install both (the source directories must be writable for |
|
|
103 | this to work): |
| 70 | |
104 | |
|
|
105 | cfutil --install-maps path/to/cfmaps-<version>/ |
|
|
106 | cfutil --install-arch path/to/cfarch-<version>/ |
|
|
107 | |
|
|
108 | Both processes can take some time, depending on your resources :) If you |
|
|
109 | plan to repeat the installation you should specify the --cache option |
|
|
110 | first, which will keep costly-to-generate files around for further runs |
|
|
111 | of cfutil: |
|
|
112 | |
|
|
113 | cfutil --cache --install-maps path/to/cfmaps-<version>/ |
|
|
114 | cfutil --cache --install-arch path/to/cfarch-<version>/ |
|
|
115 | |
|
|
116 | Atfer this you can then run the deliantra executable. This starts a |
|
|
117 | server which you/other people can connect to. |
|
|
118 | |
|
|
119 | |
|
|
120 | WEB SITES |
|
|
121 | |
| 71 | The following web addresses have crossfire information that you may find |
122 | The following web addresses have deliantra information that you may find |
| 72 | useful: |
123 | useful: |
| 73 | |
124 | |
| 74 | http://crossfire.schmorp.de/ (The main site) |
125 | http://www.deliantra.net/ (The main site) |
| 75 | |
|
|
| 76 | http://crossfire.real-time.com/ (The website for the old Crossfire game) |
|
|
| 77 | |
126 | |
| 78 | |
127 | |
| 79 | REPORTING BUGS |
128 | REPORTING BUGS |
| 80 | |
129 | |
| 81 | 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 |
| 82 | mentioned. |
131 | mentioned. |
| 83 | |
132 | |
| 84 | Bugs should be filed using the following email address: |
133 | Bugs should be filed using the following email address: |
| 85 | crossfire@schmorp.de |
134 | support@deliantra.net |
| 86 | |
135 | |
| 87 | When reporting bugs, make sure you include the following: |
136 | When reporting bugs, make sure you include the following: |
|
|
137 | |
| 88 | o What version of crossfire did you use? |
138 | * What version of deliantra did you use? |
| 89 | o What type of computer did you use (CPU type) |
139 | * What type of computer did you use (CPU type) |
| 90 | o What is the version of the OS? |
140 | * What is the version of the OS? |
| 91 | o 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) |
| 92 | o 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)? |
| 93 | o Which flags did you give it? |
143 | * Which flags did you give it? |
| 94 | o 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 |
| 95 | 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 |
| 96 | sort 'it failed with a line like ...' doesn't help any. |
146 | sort 'it failed with a line like ...' doesn't help any. |
| 97 | o If the bug happened while running crossfire: |
147 | * If the bug happened while running deliantra: |
| 98 | - Include any output before to the bug. |
148 | - Include any output before to the bug. |
| 99 | - 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 |
| 100 | detailed the description, the better chance I have of figuring |
150 | detailed the description, the better chance we have of figuring |
| 101 | out where the bug happened, or how I can recreate the bug. |
151 | out where the bug happened, or how we can recreate the bug. |
| 102 | - 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 |
| 103 | helpful. |
153 | helpful. |
| 104 | |
154 | |
| 105 | The more information provided, the better chance of the bug being fixed in |
155 | The more information provided, the better chance of the bug being fixed |
| 106 | a timely fashion. |
156 | in a timely fashion. |
| 107 | |
157 | |
| 108 | ------------------------------------------------------------------------------ |
|
|
| 109 | SUBMITTING PATCHES: |
|
|
| 110 | Patches should be submitted to email address: |
|
|
| 111 | crossfire@schmorp.de |
|
|
| 112 | |
158 | |
| 113 | PUBLIC SERVERS: |
159 | SUBMITTING PATCHES |
| 114 | |
160 | |
|
|
161 | Patches should be submitted to email address: |
|
|
162 | support@deliantra.net |
|
|
163 | |
|
|
164 | |
|
|
165 | PUBLIC SERVERS |
|
|
166 | |
| 115 | The best way to find a server to play is to run the client. It will contact |
167 | The best way to find a server to play is to run the client |
| 116 | the metaserver and present a list to choose from. You can also see |
168 | and hit "Server List" in the setup dialog (this varies |
| 117 | a list at http://crossfire.real-time.com/metaserver/ |
169 | depending on your client). |
|
|
170 | |
|
|
171 | The canonical server for use with Deliantra and CFPlus is |
|
|
172 | gameserver.deliantra.net, port 13327 (the default). |
| 118 | |
173 | |
| 119 | |
174 | |
| 120 | COPYRIGHT |
175 | COPYRIGHT |
| 121 | |
176 | |
| 122 | Copyright (C) 2007 Crossfire Development Team |
177 | Most files in this distribution are covered by the GNU General Public |
| 123 | Copyright (C) 2000, 2006 Mark Wedel |
178 | License, version 3 (COPYING.GPL), or any later version, with the |
| 124 | Copyright (C) 1992 Frank Tore Johansen |
179 | exception of ext/affero.ext, which is covered by the GNU Affero General |
|
|
180 | Public License, Version 3 (COPYING.Affero). Please take note of the |
|
|
181 | special requirements of the Affero license with respect to network |
|
|
182 | servers and configure your network server according to the instructions |
|
|
183 | given in ext/affero.ext. |
| 125 | |
184 | |
| 126 | This program is free software; you can redistribute it and/or modify |
|
|
| 127 | it under the terms of the GNU General Public License as published by |
|
|
| 128 | the Free Software Foundation; either version 2 of the License, or |
|
|
| 129 | (at your option) any later version. |
|
|
| 130 | |
185 | |
| 131 | This program is distributed in the hope that it will be useful, |
186 | CONTACT |
| 132 | but WITHOUT ANY WARRANTY; without even the implied warranty of |
|
|
| 133 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
|
|
| 134 | GNU General Public License for more details. |
|
|
| 135 | |
187 | |
| 136 | You should have received a copy of the GNU General Public License |
188 | The authors can be reached via e-mail to support@deliantra.net |
| 137 | along with this program; if not, write to the Free Software |
|
|
| 138 | Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. |
|
|
| 139 | |
189 | |
| 140 | The authors can be reached via e-mail to crossfire@schmorp.de |
|
|
