ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/deliantra/server/README
Revision: 1.8
Committed: Mon Mar 12 17:41:11 2007 UTC (17 years, 2 months ago) by root
Branch: MAIN
Changes since 1.7: +42 -33 lines
Log Message:
updated README

File Contents

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