ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/deliantra/server/README
Revision: 1.4
Committed: Mon Mar 5 19:34:20 2007 UTC (17 years, 2 months ago) by pippijn
Branch: MAIN
Changes since 1.3: +60 -73 lines
Log Message:
partially rewrote README

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