ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/deliantra/server/README
Revision: 1.6
Committed: Tue Mar 6 22:07:56 2007 UTC (17 years, 2 months ago) by root
Branch: MAIN
Changes since 1.5: +2 -1 lines
Log Message:
add cfutil stub, move checks likely to fail to be done earlier in configure, require optipng

File Contents

# Content
1 WHAT IS CROSSFIRE?
2
3 This is a multiplayer graphical arcade and adventure game, that runs on a
4 client/server model. There are clients for Microsoft(R) Windows(TM) and
5 POSIX systems such as Linux and *BSD. To get the most joyful experience,
6 the Crossfire+ client should be used. This client is written in Perl and
7 utilises SDL with OpenGL.
8
9 Crossfire has certain flavours from other games, especially Gauntlet (TM)
10 and Nethack/Moria.
11
12 Any number of players can move around in their own window, finding
13 and using items and battle monsters. They can choose to cooperate
14 or compete in the same "world".
15
16 REQUIREMENTS
17
18 For UNIX, a modern C++ compiler with some extensions is required to
19 compile this game. In addition, you will need the Perl development
20 libraries along with the following Perl modules (the server is tested
21 with perl 5.8.8 and 5.8-maint).
22
23 - Crossfire >= v0.97
24 - Coro >= v3.5
25 - Coro::Event >= v2.1
26 - Event >= v1.08
27 - IO::AIO >= 2.32
28 - BDB >= v0.1
29 - Storable >= v2.0
30 - Time::HiRes >= v1.0
31 - YAML::Syck >= v0.71
32 - Digest::MD5 >= v2.0
33 - Compress::LZF >= v1.71
34 - Safe::Hole >= v0.10
35 - Pod::POM >= v0.17
36
37 Furthermore, you will need the following programs and libraries:
38
39 - gperf, the GNU perfect hash generator
40 - glib-2.0 >= v2.10
41 - libpng >= v1.2
42 - ImageMagick >= 6.0 (convert must be in your PATH).
43 - optipng (http://optipng.sf.net)
44
45 Your compiler must support the Library Technical Report 1 extensions and
46 the upcoming typeof extension. The GNU C++ compiler >= version 4.0 does
47 support all these.
48
49 COMPILING
50
51 Crossfire has been known to compile on a wide variety of systems. It should
52 compile and most all ISO C++ 200x and POSIX compliant systems.
53
54 To get directions on compilation for UNIX/LINUX, read the INSTALL file.
55
56 USAGE
57
58 Crossfire runs on a client/server model. You will also need the client
59 to play. You can either connect to a server someone else has set up,
60 or run your own server and connect to that. The client package has
61 information for connecting to servers.
62
63 To run your own server, you need to make the crossfire binaries
64 and install them, and then run the crossfire program. This now
65 creates a server which you/other people can connect to. The map
66 files will need to get downloaded and installed for the server to run
67 properly. The map pack is released together with the server and can be
68 downloaded form the same location. The maps should be copied into the
69 $(TARGET)/share/crossfire/maps directory - after unpacking, you should
70 have a $(TARGET)/share/crossfire/maps/scorn directory.
71
72 If you plan to run a long term server, you should use one of the scripts
73 provided that will re-run crossfire if it dies for some reason.
74
75 WEB SITES:
76
77 The following web addresses have crossfire information that you may find
78 useful:
79
80 http://crossfire.schmorp.de/ (The main site)
81
82 http://crossfire.real-time.com/ (The website for the old Crossfire game)
83
84
85 REPORTING BUGS
86
87 First, check the INSTALL file for common problems, and see if yours is
88 mentioned.
89
90 Bugs should be filed using the following email address:
91 crossfire@schmorp.de
92
93 When reporting bugs, make sure you include the following:
94 o What version of crossfire did you use?
95 o What type of computer did you use (CPU type)
96 o What is the version of the OS?
97 o What windowing system are you using (e.g. openwindows, X.org, XFree86)
98 o What compiler (and its version) did you use (e.g. gcc, acc)?
99 o Which flags did you give it?
100 o If the bug happens when compiling crossfire, send an EXACT copy of the
101 compiler line, as well as the errors it puts out. Sending bugs of the
102 sort 'it failed with a line like ...' doesn't help any.
103 o If the bug happened while running crossfire:
104 - Include any output before to the bug.
105 - Give a description of what you did before the bug occured. The better
106 detailed the description, the better chance I have of figuring
107 out where the bug happened, or how I can recreate the bug.
108 - If possible, a stack trace from gdb (or other debugger) is very
109 helpful.
110
111 The more information provided, the better chance of the bug being fixed in
112 a timely fashion.
113
114 ------------------------------------------------------------------------------
115 SUBMITTING PATCHES:
116 Patches should be submitted to email address:
117 crossfire@schmorp.de
118
119 PUBLIC SERVERS:
120
121 The best way to find a server to play is to run the client. It will contact
122 the metaserver and present a list to choose from. You can also see
123 a list at http://crossfire.real-time.com/metaserver/
124
125
126 COPYRIGHT
127
128 Copyright (C) 2007 Crossfire Development Team
129 Copyright (C) 2000, 2006 Mark Wedel
130 Copyright (C) 1992 Frank Tore Johansen
131
132 This program is free software; you can redistribute it and/or modify
133 it under the terms of the GNU General Public License as published by
134 the Free Software Foundation; either version 2 of the License, or
135 (at your option) any later version.
136
137 This program is distributed in the hope that it will be useful,
138 but WITHOUT ANY WARRANTY; without even the implied warranty of
139 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
140 GNU General Public License for more details.
141
142 You should have received a copy of the GNU General Public License
143 along with this program; if not, write to the Free Software
144 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
145
146 The authors can be reached via e-mail to crossfire@schmorp.de