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

Comparing deliantra/server/README (file contents):
Revision 1.1 by root, Fri Feb 3 07:11:13 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. 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
7 in Perl and utilises SDL with OpenGL to provide you with the most
8 immersive gameplay.
6 9
7 It has certain flavours from other games, especially Gauntlet (TM) 10 Crossfire has certain flavours from other games, especially Gauntlet (TM)
8 and Nethack/Moria. 11 and Nethack/Moria.
9 12
10 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
11 and using items and battle monsters. They can choose to cooperate 14 world, finding and using items and battle monsters. They can choose to
12 or compete in the same "world". 15 cooperate or compete in the same "world".
16
13 17
14REQUIREMENTS 18REQUIREMENTS
15 19
16 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
17 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
18 map editor. 22 libraries along with the following Perl modules (the server is tested
23 with perl 5.8.8 and 5.8-maint).
19 24
20 For Windows 9x, you need Visual C++ (or some other ANSI C 25 - BDB >= v0.1
21 compiler that can read ".dsw"-files). 26 - Compress::LZF >= v1.71
22 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
23COMPILING 61COMPILING
24 62
25 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
26 systems. It should compile and most all ANSI C and Posix 64 compile and run on most ISO C++ 200x and POSIX compliant systems.
27 compliant systems.
28 65
29 To get directions on compilation for UNIX/LINUX, read the INSTALL file. 66 To get generic directions on compilation, read the INSTALL file.
30 For Win9x, read INSTALL_WIN32.txt.
31
32USAGE
33
34 Crossfire runs on a client/server model. You will also need the
35 client to play. You can either connect to a server someone else
36 has set up, or run your own server and connect to that. The
37 client package has information for connecting to servers.
38
39 To run your own server, you need to make the crossfire binaries and install
40 them, and then run the crossfire program. This now creates a server which
41 you/other people can connect to. The map files will need to get downloaded
42 and installed for the server to run properly. If you plan to run a long
43 term server, you should use one of the scripts provided that will re-run
44 crossfire if it dies for some reason.
45
46MAILING LIST
47
48 For the latest subscription for crossfire mailing lists, go to:
49 http://crossfire.real-time.com/Website_Index/Mailing_Lists/mailing_lists.jhtml
50
51 From there you should be able to subscribe/unsubscribe any of the mailing
52 lists. The mailing lists based off the ifi.uio.no host are being
53 discontinued.
54
55 An archive of old messages can be found at
56 http://www.real-time.com/maillists/rte/crossfire
57 67
58 68
59FTP SITES 69INSTALLATION/USAGE
60 70
61 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).
62 75
63 ftp://ftp.sourceforge.net/pub/sourceforge/crossfire 76 To run your own server, you need to make the crossfire binaries and
64 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.
65 80
66 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
67 repository. Information on anonymous CVS access as 82 to install both:
68 the download CVS snapshots and browsing the repository can be
69 found at:
70 http://sourceforge.net/cvs/?group_id=13833
71 83
84 cfutil --install-maps path/to/cfmaps-<version>/
85 cfutil --install-arch path/to/cfarch-<version>/
72 86
73 If you are looking for a windows/NT client, look at: 87 Both processes can take some time, depending on your resources :)
74 http://mids.student.utwente.nl/%7Emichtoen/crossfire/ 88
75 89
76WEB SITES: 90WEB SITES:
77 91
78 The following web addresses have crossfire information that you may find 92 The following web addresses have crossfire information that you may find
79 useful: 93 useful:
80 94
81 http://crossfire.real-time.com/ 95 http://crossfire.schmorp.de/ (The main site)
82 real-time is the main crossfire site. 96
97 http://crossfire.real-time.com/ (The website for the old Crossfire game)
83 98
84 99
85REPORTING BUGS 100REPORTING BUGS
86 101
87 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
88 mentioned. 103 mentioned.
89 104
90 The mailing list is where present development work and bugs are typically 105 Bugs should be filed using the following email address:
91 discussed. If you want to know what is happening with crossfire, join the 106 crossfire@schmorp.de
92 list and please ask there.
93
94 I will likely delete mail messages of the following sort:
95 1) Bug reports of failed installation when the installation instructions
96 were not followed.
97 2) Bug reports that contain so little information that it tells me nothing
98 more than the fact that there is a bug.
99 3) Bugs in which the solution has already been answered in the INSTALL
100 file.
101 107
102 When reporting bugs, make sure you include the following: 108 When reporting bugs, make sure you include the following:
103 o What version of crossfire did you use? 109 o What version of crossfire did you use?
104 o What type of computer did you use? 110 o What type of computer did you use (CPU type)
105 o What release of the operating system did it have? 111 o What is the version of the OS?
106 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)
107 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)?
108 o Which flags did you give it? 114 o Which flags did you give it?
109 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
110 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
111 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.
112 o If the bug happened while running crossfire: 118 o If the bug happened while running crossfire:
113 - Include any output before to the bug. 119 - Include any output before to the bug.
114 - 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
115 detailed the description, the better chance I have of figuring 121 detailed the description, the better chance I have of figuring
116 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.
117 o If you managed to compile Crossfire, include the output of 123 - If possible, a stack trace from gdb (or other debugger) is very
118 "crossfire -o". 124 helpful.
119 125
120 Lack of any of this information in a bug report can make that bug report 126The more information provided, the better chance of the bug being fixed in
121useless. Also, if you have a bug, make sure you are using the latest 127a timely fashion.
122version. If you report a bug that has since been fixed, you are not likely
123to get any help.
124 128
125Further debugging informatiion can be found at 129SUBMITTING PATCHES:
126http://crossfire.real-time.com/debugging_tips.html
127 130
128 Mail the bug report to crossfire-devel@listserv.real-time.com 131 Patches should be submitted to email address:
129 132 crossfire@schmorp.de
130------------------------------------------------------------------------------
131SUBMITTING PATCHES: See the doc/programming_guide file.
132
133 133
134PUBLIC SERVERS: 134PUBLIC SERVERS:
135 135
136The 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
137the 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
138a list at http://crossfire.real-time.com/metaserver/ 139 http://crossfire.real-time.com/metaserver/.
139 140
141 The canonical server for use with Crossfire and CFPlus is
142 crossfire.schmorp.de, port 13327 (default).
140 143
141COPYRIGHT 144COPYRIGHT
142 145
143 Don't get scared by the below, it's included just for "safety" reasons 8) 146 Copyright (C) 2007 Crossfire Development Team
144 (Don't want anyone to start selling the game)
145
146 Copyright (C) 2000 Mark Wedel 147 Copyright (C) 2000, 2006 Mark Wedel
147 Copyright (C) 1992 Frank Tore Johansen 148 Copyright (C) 1992 Frank Tore Johansen
148 149
149 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
150 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
151 the Free Software Foundation; either version 2 of the License, or 152 the Free Software Foundation; either version 2 of the License, or
… …
158 159
159 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
160 along with this program; if not, write to the Free Software 161 along with this program; if not, write to the Free Software
161 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. 162 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
162 163
163 The author can be reached via e-mail to mwedel@scruz.net 164 The authors can be reached via e-mail to crossfire@schmorp.de

Diff Legend

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