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

Comparing deliantra/server/README (file contents):
Revision 1.2 by root, Fri Dec 15 20:07:02 2006 UTC vs.
Revision 1.10 by root, Fri Apr 27 19:53:04 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. In addition, you will need the Perl development
19 map editor. 22 libraries along with the following Perl modules (the server is tested
23 with perl 5.8.8 and 5.8-maint).
20 24
21 For Windows 9x, you need Visual C++ (or some other ANSI C 25 - BDB >= v0.1
22 compiler that can read ".dsw"-files). 26 - Compress::LZF >= v1.71
23 27 - Coro >= v3.62
28 - Coro::Event >= v2.1
29 - Crossfire >= v0.97
30 - Digest::MD5 >= v2.0
31 - Event >= v1.08
32 - IO::AIO >= 2.32
33 - JSON::XS => 1.11
34 - Pod::POM >= v0.17
35 - Safe::Hole >= v0.10
36 - Storable >= v2.0
37 - Time::HiRes >= v1.0
38 - YAML::Syck >= v0.71
39
40 Furthermore, you will need the following programs and libraries:
41
42 - gperf, the GNU perfect hash generator >= v3.0
43 - glib-2.0 >= v2.10
44 - libpng >= v1.2
45 - ImageMagick >= v6.0
46 - optipng => v0.5.5 (http://optipng.sf.net)
47 - pngnq >= 0.4 (http://freshmeat.net/redir/pngnq/53146/url_homepage/pngnq.html)
48 - rsync >= 2.6 (a must have anyways)
49
50 Your compiler must support the Library Technical Report 1 extensions and
51 the upcoming typeof extension. The GNU C++ compiler >= version 4.0 does
52 support all these.
53
54 On Debian GNU/Linux, you might get away with something like this for many of the
55 above dependencies:
56
57 apt-get install gperf optipng pngnq rsync imagemagick libglib2.0-dev libpng12-dev
58 apt-get install libpod-pom-perl libsafe-hole-perl libevent-perl
59
60
24COMPILING 61COMPILING
25 62
26 Crossfire has been known to compile on a wide variety of 63 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 64 compile and run on most ISO C++ 200x and POSIX compliant systems.
28 compliant systems.
29 65
30 To get directions on compilation for UNIX/LINUX, read the INSTALL file. 66 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 67
60 68
61FTP SITES 69INSTALLATION/USAGE
62 70
63 FTP-sites where you can look for the latest versions are: 71 Crossfire runs on a client/server model. You will also a client to
72 play. You can either connect to a server someone else has set up, or
73 run your own server and connect to that. There are a number of clients
74 available, but the recommended one is CFPlus (see below for URL).
64 75
65 http://prdownloads.sourceforge.net/crossfire/ 76 To run your own server, you need to make the crossfire binaries and
66 ftp://ftp.real-time.com/pub/games/crossfire 77 install them, and then run the crossfire program. This now creates a
78 server which you/other people can connect to. First you have to download
79 and install maps and archetype packs, though.
67 80
68 Changes made since the latest release can be found at the CVS 81 Download both the cfmaps-<version> and cfarch-<version> archives, then use cfutil
69 repository. Information on anonymous CVS access as 82 to install both:
70 the download CVS snapshots and browsing the repository can be 83
71 found at: 84 cfutil --install-maps path/to/cfmaps-<version>/
72 http://sourceforge.net/cvs/?group_id=13833 85 cfutil --install-arch path/to/cfarch-<version>/
86
87 Both processes can take some time, depending on your resources :)
73 88
74 89
75WEB SITES: 90WEB SITES:
76 91
77 The following web addresses have crossfire information that you may find 92 The following web addresses have crossfire information that you may find
78 useful: 93 useful:
79 94
80 http://crossfire.real-time.com/ 95 http://crossfire.schmorp.de/ (The main site)
81 real-time is the main crossfire site. 96
97 http://crossfire.real-time.com/ (The website for the old Crossfire game)
82 98
83 99
84REPORTING BUGS 100REPORTING BUGS
85 101
86 First, check the INSTALL file for common problems, and see if yours is 102 First, check the INSTALL file for common problems, and see if yours is
87 mentioned. 103 mentioned.
88 104
89 Bugs should be filed at the sourceforge web site: 105 Bugs should be filed using the following email address:
90 http://sourceforge.net/cvs/?group_id=13833 106 crossfire@schmorp.de
91 107
92 When reporting bugs, make sure you include the following: 108 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
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? 109 o What version of crossfire did you use?
97 o What type of computer did you use (CPU type) 110 o What type of computer did you use (CPU type)
98 o What is the version of the OS? 111 o What is the version of the OS?
99 o What windowing system are you using (Ie, openwindows, X11R6, etc) 112 o 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)? 113 o What compiler (and its version) did you use (e.g. gcc, acc)?
101 o Which flags did you give it? 114 o Which flags did you give it?
102 o If the bug happens when compiling crossfire, send an EXACT copy of 115 o 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 116 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. 117 sort 'it failed with a line like ...' doesn't help any.
105 o If the bug happened while running crossfire: 118 o If the bug happened while running crossfire:
106 - Include any output before to the bug. 119 - Include any output before to the bug.
107 - Give a description of what you did before the bug occured. The better 120 - Give a description of what you did before the bug occured. The better
108 detailed the description, the better chance I have of figuring 121 detailed the description, the better chance I have of figuring
109 out where the bug happened, or how I can recreate the bug. 122 out where the bug happened, or how I can recreate the bug.
110 - If possible, a stack trace from gdb (or other debugger) is very 123 - If possible, a stack trace from gdb (or other debugger) is very
111 helpful. 124 helpful.
112 125
113The more information provided, the better chance of the bug being fixed in 126The more information provided, the better chance of the bug being fixed in
114a timely fashion. 127a timely fashion.
115 128
116Further debugging informatiion can be found at 129SUBMITTING PATCHES:
117http://crossfire.real-time.com/debugging_tips.html
118 130
119------------------------------------------------------------------------------ 131 Patches should be submitted to email address:
120SUBMITTING PATCHES: See the doc/programming_guide file. 132 crossfire@schmorp.de
121 The patches should be submitted to the patch tracker on sourceforge:
122 http://sourceforge.net/cvs/?group_id=13833
123 133
124PUBLIC SERVERS: 134PUBLIC SERVERS:
125 135
126The best way to find a server to play is to run the client. It will contact 136 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 137 and hit "Server List" in the setup dialog (this varies
138 depending on your client). You can also see a list at
128a list at http://crossfire.real-time.com/metaserver/ 139 http://crossfire.real-time.com/metaserver/.
129 140
141 The canonical server for use with Crossfire and CFPlus is
142 crossfire.schmorp.de, port 13327 (default).
130 143
131COPYRIGHT 144COPYRIGHT
132 145
133 Don't get scared by the below, it's included just for "safety" reasons 8) 146 Copyright (C) 2007 Crossfire Development Team
134 (Don't want anyone to start selling the game)
135
136 Copyright (C) 2000,2006 Mark Wedel 147 Copyright (C) 2000, 2006 Mark Wedel
137 Copyright (C) 1992 Frank Tore Johansen 148 Copyright (C) 1992 Frank Tore Johansen
138 149
139 This program is free software; you can redistribute it and/or modify 150 This program is free software; you can redistribute it and/or modify
140 it under the terms of the GNU General Public License as published by 151 it under the terms of the GNU General Public License as published by
141 the Free Software Foundation; either version 2 of the License, or 152 the Free Software Foundation; either version 2 of the License, or
… …
148 159
149 You should have received a copy of the GNU General Public License 160 You should have received a copy of the GNU General Public License
150 along with this program; if not, write to the Free Software 161 along with this program; if not, write to the Free Software
151 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. 162 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
152 163
153 The author can be reached via e-mail to crossfire.de 164 The authors can be reached via e-mail to crossfire@schmorp.de

Diff Legend

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