| 1 | WHAT IS CROSSFIRE? |
1 | WHAT 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". |
| 16 | |
16 | |
| 17 | |
17 | |
| 18 | REQUIREMENTS |
18 | REQUIREMENTS |
| 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. In addition, you will need the Perl development |
21 | compile this game (g++ 4.x works). In addition, you will need the Perl |
| 22 | libraries along with the following Perl modules (the server is tested |
22 | development libraries along with the following Perl modules (the server |
| 23 | with perl 5.8.8 and 5.8-maint). |
23 | is tested with perl 5.8.8 and 5.8-maint) and their dependencies. In general, |
|
|
24 | the newest version from CPAN will do. The configure script will complain |
|
|
25 | when it detects an unsuitable version. |
| 24 | |
26 | |
| 25 | - BDB >= v0.1 |
27 | - AnyEvent |
|
|
28 | - BDB **compiled against libdb4.5 or 4.6, libdb4.4 might work** |
| 26 | - Compress::LZF >= v1.71 |
29 | - Compress::LZF |
| 27 | - Coro >= v3.62 **SEE IMPORTANT NOTICE BELOW** |
30 | - Coro **SEE IMPORTANT NOTICE BELOW** |
| 28 | - Coro::Event >= v2.1 |
31 | - Coro::EV |
| 29 | - Crossfire >= v0.97 |
32 | - Deliantra |
| 30 | - Digest::MD5 >= v2.0 |
33 | - Digest::MD5 |
| 31 | - Event >= v1.08 |
34 | - EV |
| 32 | - IO::AIO >= 2.32 |
35 | - IO::AIO |
| 33 | - JSON::XS => 1.11 |
36 | - JSON::XS |
|
|
37 | - Net::IRC3 |
| 34 | - Pod::POM >= v0.17 |
38 | - Pod::POM |
| 35 | - Safe::Hole >= v0.10 |
39 | - Safe::Hole |
| 36 | - Storable >= v2.0 |
40 | - Storable |
| 37 | - Time::HiRes >= v1.0 |
41 | - Time::HiRes |
|
|
42 | - URI |
|
|
43 | - YAML |
| 38 | - YAML::Syck >= v0.71 |
44 | - YAML::Syck |
| 39 | |
45 | |
| 40 | **NOTICE**: Crossfire uses an alternative signal stack, so you have to |
46 | **NOTICE**: Deliantra uses an alternative signal stack, so you have to |
| 41 | use either the "u"context method or "a"ssembly when configuring Coro. |
47 | use either the "u"context method (slow) or "a"ssembly when configuring Coro. |
| 42 | |
48 | |
| 43 | Furthermore, you will need the following programs and libraries: |
49 | Furthermore, you will need the following programs and libraries: |
| 44 | |
50 | |
| 45 | - gperf, the GNU perfect hash generator >= v3.0 |
51 | - gperf, the GNU perfect hash generator >= v3.0 |
| 46 | - glib-2.0 >= v2.10 |
52 | - glib-2.0 >= v2.10 |
| 47 | - libpng >= v1.2 |
53 | - libpng >= v1.2 |
| 48 | - ImageMagick >= v6.0 |
54 | - ImageMagick >= v6.0 (possibly higher, depending on its bugs) |
| 49 | - optipng => v0.5.5 (http://optipng.sf.net) |
55 | - optipng => v0.5.5 (http://optipng.sf.net) |
| 50 | - pngnq >= 0.4 (http://freshmeat.net/redir/pngnq/53146/url_homepage/pngnq.html) |
56 | - pngnq >= v0.4 (http://freshmeat.net/redir/pngnq/53146/url_homepage/pngnq.html) |
| 51 | - rsync >= 2.6 (a must have anyways) |
57 | - rsync >= v2.6 (a must have anyways) |
| 52 | |
58 | |
| 53 | Your compiler must support the Library Technical Report 1 extensions and |
59 | Your compiler must support the Library Technical Report 1 extensions and |
| 54 | the upcoming typeof extension. The GNU C++ compiler >= version 4.0 does |
60 | the upcoming typeof extension. The GNU C++ compiler >= version 4.0 does |
| 55 | support all these. |
61 | support all these. |
| 56 | |
62 | |
| … | |
… | |
| 58 | above dependencies: |
64 | above dependencies: |
| 59 | |
65 | |
| 60 | apt-get install gperf optipng pngnq rsync imagemagick libglib2.0-dev libpng12-dev |
66 | apt-get install gperf optipng pngnq rsync imagemagick libglib2.0-dev libpng12-dev |
| 61 | apt-get install libpod-pom-perl libsafe-hole-perl libevent-perl |
67 | apt-get install libpod-pom-perl libsafe-hole-perl libevent-perl |
| 62 | |
68 | |
|
|
69 | If you want to get sensible backtraces for error conditions at runtime |
|
|
70 | to be logged you also need the external addr2line program (part of GNU |
|
|
71 | binutils) in your PATH. |
|
|
72 | |
| 63 | |
73 | |
| 64 | COMPILING |
74 | COMPILING |
| 65 | |
75 | |
| 66 | 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 |
| 67 | 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. |
| 68 | |
78 | |
| 69 | To get generic directions on compilation, read the INSTALL file. |
79 | To get generic directions on compilation, read the INSTALL file. |
| 70 | |
80 | |
| 71 | |
81 | |
| 72 | INSTALLATION/USAGE |
82 | INSTALLATION/USAGE |
| 73 | |
83 | |
| 74 | 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 |
| 75 | 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 |
| 76 | 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 |
| 77 | available, but the recommended one is CFPlus (see below for URL). |
87 | available, but the recommended one is CFPlus (see below for URL). |
| 78 | |
88 | |
| 79 | To run your own server, you need to make the crossfire binaries and |
89 | To run your own server, you need to build the deliantra server binaries |
| 80 | install them, and then run the crossfire program. This now creates a |
90 | and install them, then you will have to download and install map and |
| 81 | server which you/other people can connect to. First you have to download |
91 | archetype packs: |
| 82 | and install maps and archetype packs, though. |
|
|
| 83 | |
92 | |
| 84 | Download both the cfmaps-<version> and cfarch-<version> archives, then use cfutil |
93 | Download both the cfmaps-<version> and cfarch-<version> archives, then |
| 85 | to install both: |
94 | use cfutil to install both (the source directories must be writable for |
|
|
95 | this to work): |
| 86 | |
96 | |
| 87 | cfutil --install-maps path/to/cfmaps-<version>/ |
97 | cfutil --install-maps path/to/cfmaps-<version>/ |
| 88 | cfutil --install-arch path/to/cfarch-<version>/ |
98 | cfutil --install-arch path/to/cfarch-<version>/ |
| 89 | |
99 | |
| 90 | Both processes can take some time, depending on your resources :) |
100 | Both processes can take some time, depending on your resources :) If you |
|
|
101 | plan to repeat the installation you should specify the --cache option |
|
|
102 | first, which will keep costly-to-generate files around for further runs |
|
|
103 | of cfutil: |
|
|
104 | |
|
|
105 | cfutil --cache --install-maps path/to/cfmaps-<version>/ |
|
|
106 | cfutil --cache --install-arch path/to/cfarch-<version>/ |
|
|
107 | |
|
|
108 | Atfer this you can then run the deliantra executable. This starts a |
|
|
109 | server which you/other people can connect to. |
| 91 | |
110 | |
| 92 | |
111 | |
| 93 | WEB SITES: |
112 | WEB SITES |
| 94 | |
113 | |
| 95 | The following web addresses have crossfire information that you may find |
114 | The following web addresses have deliantra information that you may find |
| 96 | useful: |
115 | useful: |
| 97 | |
116 | |
| 98 | http://crossfire.schmorp.de/ (The main site) |
117 | http://www.deliantra.net/ (The main site) |
| 99 | |
|
|
| 100 | http://crossfire.real-time.com/ (The website for the old Crossfire game) |
|
|
| 101 | |
118 | |
| 102 | |
119 | |
| 103 | REPORTING BUGS |
120 | REPORTING BUGS |
| 104 | |
121 | |
| 105 | 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 |
| 106 | mentioned. |
123 | mentioned. |
| 107 | |
124 | |
| 108 | Bugs should be filed using the following email address: |
125 | Bugs should be filed using the following email address: |
| 109 | crossfire@schmorp.de |
126 | support@deliantra.net |
| 110 | |
127 | |
| 111 | When reporting bugs, make sure you include the following: |
128 | When reporting bugs, make sure you include the following: |
|
|
129 | |
| 112 | o What version of crossfire did you use? |
130 | * What version of deliantra did you use? |
| 113 | o What type of computer did you use (CPU type) |
131 | * What type of computer did you use (CPU type) |
| 114 | o What is the version of the OS? |
132 | * What is the version of the OS? |
| 115 | o 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) |
| 116 | o 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)? |
| 117 | o Which flags did you give it? |
135 | * Which flags did you give it? |
| 118 | o 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 |
| 119 | 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 |
| 120 | sort 'it failed with a line like ...' doesn't help any. |
138 | sort 'it failed with a line like ...' doesn't help any. |
| 121 | o If the bug happened while running crossfire: |
139 | * If the bug happened while running deliantra: |
| 122 | - Include any output before to the bug. |
140 | - Include any output before to the bug. |
| 123 | - 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 |
| 124 | detailed the description, the better chance I have of figuring |
142 | detailed the description, the better chance we have of figuring |
| 125 | out where the bug happened, or how I can recreate the bug. |
143 | out where the bug happened, or how we can recreate the bug. |
| 126 | - 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 |
| 127 | helpful. |
145 | helpful. |
| 128 | |
146 | |
| 129 | The more information provided, the better chance of the bug being fixed in |
147 | The more information provided, the better chance of the bug being fixed |
| 130 | a timely fashion. |
148 | in a timely fashion. |
| 131 | |
149 | |
| 132 | SUBMITTING PATCHES: |
|
|
| 133 | |
150 | |
| 134 | Patches should be submitted to email address: |
151 | SUBMITTING PATCHES |
| 135 | crossfire@schmorp.de |
|
|
| 136 | |
152 | |
| 137 | PUBLIC SERVERS: |
153 | Patches should be submitted to email address: |
|
|
154 | support@deliantra.net |
| 138 | |
155 | |
| 139 | The best way to find a server to play is to run the client |
|
|
| 140 | and hit "Server List" in the setup dialog (this varies |
|
|
| 141 | depending on your client). You can also see a list at |
|
|
| 142 | http://crossfire.real-time.com/metaserver/. |
|
|
| 143 | |
156 | |
|
|
157 | PUBLIC SERVERS |
|
|
158 | |
|
|
159 | The best way to find a server to play is to run the client |
|
|
160 | and hit "Server List" in the setup dialog (this varies |
|
|
161 | depending on your client). |
|
|
162 | |
| 144 | The canonical server for use with Crossfire and CFPlus is |
163 | The canonical server for use with Deliantra and CFPlus is |
| 145 | crossfire.schmorp.de, port 13327 (default). |
164 | gameserver.deliantra.net, port 13327 (the default). |
|
|
165 | |
| 146 | |
166 | |
| 147 | COPYRIGHT |
167 | COPYRIGHT |
| 148 | |
168 | |
| 149 | Copyright (C) 2007 Crossfire Development Team |
169 | Most files in this distribution are covered by the GNU General Public |
| 150 | Copyright (C) 2000, 2006 Mark Wedel |
170 | License, version 3 (COPYING.GPL), or any later version, with the |
| 151 | Copyright (C) 1992 Frank Tore Johansen |
171 | exception of ext/affero.ext, which is covered by the GNU Affero General |
|
|
172 | Public License, Version 3 (COPYING.Affero). Please take note of the |
|
|
173 | special requirements of the Affero license with respect to network |
|
|
174 | servers and configure your network server according to the instructions |
|
|
175 | given in ext/affero.ext. |
| 152 | |
176 | |
| 153 | This program is free software; you can redistribute it and/or modify |
|
|
| 154 | it under the terms of the GNU General Public License as published by |
|
|
| 155 | the Free Software Foundation; either version 2 of the License, or |
|
|
| 156 | (at your option) any later version. |
|
|
| 157 | |
177 | |
| 158 | This program is distributed in the hope that it will be useful, |
178 | CONTACT |
| 159 | but WITHOUT ANY WARRANTY; without even the implied warranty of |
|
|
| 160 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
|
|
| 161 | GNU General Public License for more details. |
|
|
| 162 | |
179 | |
| 163 | You should have received a copy of the GNU General Public License |
180 | The authors can be reached via e-mail to support@deliantra.net |
| 164 | along with this program; if not, write to the Free Software |
|
|
| 165 | Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. |
|
|
| 166 | |
181 | |
| 167 | The authors can be reached via e-mail to crossfire@schmorp.de |
|
|
