ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/deliantra/server/README
(Generate patch)

Comparing deliantra/server/README (file contents):
Revision 1.3 by root, Fri Dec 15 20:08:45 2006 UTC vs.
Revision 1.14 by root, Sun May 27 02:26:17 2007 UTC

1WHAT IS CROSSFIRE? 1WHAT IS CROSSFIRE?
2 2
3 This is a multiplayer graphical arcade and adventure game made for 3 This is a multiplayer graphical arcade and adventure game, that runs on
4 the X-Windows environment. It runs on a client/server model. 4 a client/server model. There are clients for Microsoft(R) Windows(TM)
5 The client runs with X11, GTK, or SDL within a gtk window. A 5 and POSIX systems such as Linux and *BSD. To get the most joyful
6 windows client is available, and a java client is under development. 6 experience, the Crossfire+ client should be used. This client is written
7 in Perl and utilises SDL with OpenGL to provide you with the most
8 immersive gameplay.
7 9
8 It has certain flavours from other games, especially Gauntlet (TM) 10 Crossfire has certain flavours from other games, especially Gauntlet (TM)
9 and Nethack/Moria. 11 and Nethack/Moria.
10 12
11 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
12 and using items and battle monsters. They can choose to cooperate 14 world, finding and using items and battle monsters. They can choose to
13 or compete in the same "world". 15 cooperate or compete in the same "world".
16
14 17
15REQUIREMENTS 18REQUIREMENTS
16 19
17 For UNIX, X-windows and an ANSI C compiler to compile this game. 20 For UNIX, a modern C++ compiler with some extensions is required to
18 A window system is not needed if you don't want to compile the 21 compile this game (g++ 4.x works). In addition, you will need the Perl
19 map editor. 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
24 minimum versions below may not be up-to-date, the configure script will
25 check them all, though).
20 26
21 For Windows 9x, you need Visual C++ (or some other ANSI C 27 - AnyEvent >= 2.52
22 compiler that can read ".dsw"-files). 28 - BDB >= v0.1
23 29 - Compress::LZF >= v1.8
30 - Coro >= v3.62 **SEE IMPORTANT NOTICE BELOW**
31 - Coro::Event >= v2.1
32 - Crossfire >= v0.98
33 - Digest::MD5 >= v2.0
34 - Event >= v1.08
35 - IO::AIO >= 2.32
36 - JSON::XS => 1.21
37 - Pod::POM >= v0.17
38 - Safe::Hole >= v0.10
39 - Storable >= v2.0
40 - Time::HiRes >= v1.0
41 - YAML::Syck >= v0.71
42
43 **NOTICE**: Crossfire uses an alternative signal stack, so you have to
44 use either the "u"context method (slow) or "a"ssembly when configuring Coro.
45
46 Furthermore, you will need the following programs and libraries:
47
48 - gperf, the GNU perfect hash generator >= v3.0
49 - glib-2.0 >= v2.10
50 - libpng >= v1.2
51 - ImageMagick >= v6.0 (possibly higher, depending on its bugs)
52 - optipng => v0.5.5 (http://optipng.sf.net)
53 - pngnq >= 0.4 (http://freshmeat.net/redir/pngnq/53146/url_homepage/pngnq.html)
54 - rsync >= 2.6 (a must have anyways)
55
56 Your compiler must support the Library Technical Report 1 extensions and
57 the upcoming typeof extension. The GNU C++ compiler >= version 4.0 does
58 support all these.
59
60 On Debian GNU/Linux, you might get away with something like this for many of the
61 above dependencies:
62
63 apt-get install gperf optipng pngnq rsync imagemagick libglib2.0-dev libpng12-dev
64 apt-get install libpod-pom-perl libsafe-hole-perl libevent-perl
65
66 If you want to gte sensible backtraces for error conditions at runtime
67 to be logged you also need the external addr2line program (part of GNU
68 binutils) in your PATH.
69
70
24COMPILING 71COMPILING
25 72
26 Crossfire has been known to compile on a wide variety of 73 Crossfire has been known to compile on a wide variety of systems. It should
27 systems. It should compile and most all ANSI C and Posix 74 compile and run on most ISO C++ 200x and POSIX compliant systems.
28 compliant systems.
29 75
30 To get directions on compilation for UNIX/LINUX, read the INSTALL file. 76 To get generic directions on compilation, read the INSTALL file.
31 For Win9x, read INSTALL_WIN32.txt.
32
33USAGE
34
35 Crossfire runs on a client/server model. You will also need the
36 client to play. You can either connect to a server someone else
37 has set up, or run your own server and connect to that. The
38 client package has information for connecting to servers.
39
40 To run your own server, you need to make the crossfire binaries and install
41 them, and then run the crossfire program. This now creates a server which
42 you/other people can connect to. The map files will need to get downloaded
43 and installed for the server to run properly. The maps should be
44 unpacked in the $(TARGET)/share/crossfire directory - after unpacking,
45 you should have a $(TARGET)/share/crossfire/maps directory.
46
47 If you plan to run a long term server, you should use one of the scripts
48 provided that will re-run crossfire if it dies for some reason.
49
50MAILING LIST
51
52 For the latest subscription for crossfire mailing lists, go to:
53 http://crossfire.real-time.com/mailinglists/index.html
54
55 From there you should be able to subscribe/unsubscribe any of the mailing
56 lists. Links to archives of the mailing lists can be found there, as well
57 as at:
58 http://gmane.org/find.php?list=crossfire
59 77
60 78
61FTP SITES 79INSTALLATION/USAGE
62 80
63 FTP-sites where you can look for the latest versions are: 81 Crossfire runs on a client/server model. You will also a client to
82 play. You can either connect to a server someone else has set up, or
83 run your own server and connect to that. There are a number of clients
84 available, but the recommended one is CFPlus (see below for URL).
64 85
65 http://prdownloads.sourceforge.net/crossfire/ 86 To run your own server, you need to build the crossfire server binaries
66 ftp://ftp.real-time.com/pub/games/crossfire 87 and install them, then you will have to download and install map and
88 archetype packs:
67 89
68 Changes made since the latest release can be found at the CVS 90 Download both the cfmaps-<version> and cfarch-<version> archives, then
69 repository. Information on anonymous CVS access as 91 use cfutil to install both (the source directories must be writable for
70 the download CVS snapshots and browsing the repository can be 92 this to work):
71 found at: 93
72 http://sourceforge.net/cvs/?group_id=13833 94 cfutil --install-maps path/to/cfmaps-<version>/
95 cfutil --install-arch path/to/cfarch-<version>/
96
97 Both processes can take some time, depending on your resources :) If you
98 plan to repeat the installation you should specify the --cache option
99 which will keep costly-to-generate files around for further runs of
100 cfutil.
101
102 Atfer this you can then run the crossfire executable. This starts a
103 server which you/other people can connect to.
73 104
74 105
75WEB SITES: 106WEB SITES:
76 107
77 The following web addresses have crossfire information that you may find 108 The following web addresses have crossfire information that you may find
78 useful: 109 useful:
79 110
80 http://crossfire.real-time.com/ 111 http://crossfire.schmorp.de/ (The main site)
81 real-time is the main crossfire site. 112
113 http://crossfire.real-time.com/ (The website for the old Crossfire game)
82 114
83 115
84REPORTING BUGS 116REPORTING BUGS
85 117
86 First, check the INSTALL file for common problems, and see if yours is 118 First, check the INSTALL file for common problems, and see if yours is
87 mentioned. 119 mentioned.
88 120
89 Bugs should be filed at the sourceforge web site: 121 Bugs should be filed using the following email address:
90 http://sourceforge.net/cvs/?group_id=13833 122 crossfire@schmorp.de
91 123
92 When reporting bugs, make sure you include the following: 124 When reporting bugs, make sure you include the following:
93 o If you have a sourceforge login, make sure you are logged in. In this 125
94 way, if there are questions about the bug, you will be notified about
95 the request for more information.
96 o What version of crossfire did you use? 126 * What version of crossfire did you use?
97 o What type of computer did you use (CPU type) 127 * What type of computer did you use (CPU type)
98 o What is the version of the OS? 128 * What is the version of the OS?
99 o What windowing system are you using (Ie, openwindows, X11R6, etc) 129 * What windowing system are you using (e.g. openwindows, X.org, XFree86)
100 o What compiler (and its version) did you use (ie, gcc, acc, etc)? 130 * What compiler (and its version) did you use (e.g. gcc, acc)?
101 o Which flags did you give it? 131 * Which flags did you give it?
102 o If the bug happens when compiling crossfire, send an EXACT copy of 132 * If the bug happens when compiling crossfire, send an EXACT copy of the
103 the compiler line, as well as the errors it puts out. Sending bugs 133 compiler line, as well as the errors it puts out. Sending bugs of the
104 of the sort 'it failed with a line like ...' doesn't help any. 134 sort 'it failed with a line like ...' doesn't help any.
105 o If the bug happened while running crossfire: 135 * If the bug happened while running crossfire:
106 - Include any output before to the bug. 136 - Include any output before to the bug.
107 - Give a description of what you did before the bug occured. The better 137 - Give a description of what you did before the bug occured. The better
108 detailed the description, the better chance I have of figuring 138 detailed the description, the better chance we have of figuring
109 out where the bug happened, or how I can recreate the bug. 139 out where the bug happened, or how we can recreate the bug.
110 - If possible, a stack trace from gdb (or other debugger) is very 140 - If possible, a stack trace from gdb (or other debugger) is very
111 helpful. 141 helpful.
112 142
113The more information provided, the better chance of the bug being fixed in 143 The more information provided, the better chance of the bug being fixed
114a timely fashion. 144 in a timely fashion.
115 145
116Further debugging informatiion can be found at 146SUBMITTING PATCHES:
117http://crossfire.real-time.com/debugging_tips.html
118 147
119------------------------------------------------------------------------------ 148 Patches should be submitted to email address:
120SUBMITTING PATCHES: See the doc/programming_guide file. 149 crossfire@schmorp.de
121 The patches should be submitted to the patch tracker on sourceforge:
122 http://sourceforge.net/cvs/?group_id=13833
123 150
124PUBLIC SERVERS: 151PUBLIC SERVERS:
125 152
126The best way to find a server to play is to run the client. It will contact 153 The best way to find a server to play is to run the client
127the metaserver and present a list to choose from. You can also see 154 and hit "Server List" in the setup dialog (this varies
155 depending on your client). You can also see a list at
128a list at http://crossfire.real-time.com/metaserver/ 156 http://crossfire.real-time.com/metaserver/.
129 157
158 The canonical server for use with Crossfire and CFPlus is
159 crossfire.schmorp.de, port 13327 (default).
130 160
131COPYRIGHT 161COPYRIGHT
132 162
133 Don't get scared by the below, it's included just for "safety" reasons 8) 163 Copyright (C) 2006,2007 Crossfire TRT Development Team
134 (Don't want anyone to start selling the game) 164 Copyright (C) 2000,2006 Mark Wedel
165 Copyright (C) 1992 Frank Tore Johansen
135 166
136 Copyright (C) 2000,2006 Mark Wedel 167 This program is free software; you can redistribute it and/or modify
137 Copyright (C) 1992 Frank Tore Johansen 168 it under the terms of the GNU General Public License as published by
169 the Free Software Foundation; either version 2 of the License, or
170 (at your option) any later version.
138 171
139 This program is free software; you can redistribute it and/or modify 172 This program is distributed in the hope that it will be useful,
140 it under the terms of the GNU General Public License as published by 173 but WITHOUT ANY WARRANTY; without even the implied warranty of
141 the Free Software Foundation; either version 2 of the License, or 174 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
142 (at your option) any later version. 175 GNU General Public License for more details.
143 176
144 This program is distributed in the hope that it will be useful, 177 You should have received a copy of the GNU General Public License
145 but WITHOUT ANY WARRANTY; without even the implied warranty of 178 along with this program; if not, write to the Free Software
146 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 179 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
147 GNU General Public License for more details.
148 180
149 You should have received a copy of the GNU General Public License
150 along with this program; if not, write to the Free Software
151 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
152
153 The author can be reached via e-mail to crossfire@schmorp.de 181 The authors can be reached via e-mail to crossfire@schmorp.de

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines