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

Comparing deliantra/server/README (file contents):
Revision 1.3 by root, Fri Dec 15 20:08:45 2006 UTC vs.
Revision 1.7 by root, Wed Mar 7 01:23:37 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 a
4 the X-Windows environment. It runs on a client/server model. 4 client/server model. There are clients for Microsoft(R) Windows(TM) and
5 The client runs with X11, GTK, or SDL within a gtk window. A 5 POSIX systems such as Linux and *BSD. To get the most joyful experience,
6 windows client is available, and a java client is under development. 6 the Crossfire+ client should be used. This client is written in Perl and
7 utilises SDL with OpenGL.
7 8
8 It has certain flavours from other games, especially Gauntlet (TM) 9 Crossfire has certain flavours from other games, especially Gauntlet (TM)
9 and Nethack/Moria. 10 and Nethack/Moria.
10 11
11 Any number of players can move around in their own window, finding 12 Any number of players can move around in their own window, finding
12 and using items and battle monsters. They can choose to cooperate 13 and using items and battle monsters. They can choose to cooperate
13 or compete in the same "world". 14 or compete in the same "world".
14 15
15REQUIREMENTS 16REQUIREMENTS
16 17
17 For UNIX, X-windows and an ANSI C compiler to compile this game. 18 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 19 compile this game. In addition, you will need the Perl development
19 map editor. 20 libraries along with the following Perl modules (the server is tested
21 with perl 5.8.8 and 5.8-maint).
20 22
21 For Windows 9x, you need Visual C++ (or some other ANSI C 23 - Crossfire >= v0.97
22 compiler that can read ".dsw"-files). 24 - Coro >= v3.5
23 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 >= v3.0
40 - glib-2.0 >= v2.10
41 - libpng >= v1.2
42 - ImageMagick >= v6.0
43 - optipng => v0.5.5 (http://optipng.sf.net)
44 - rsync >= 2.6 (a must have anyways)
45
46 Your compiler must support the Library Technical Report 1 extensions and
47 the upcoming typeof extension. The GNU C++ compiler >= version 4.0 does
48 support all these.
49
24COMPILING 50COMPILING
25 51
26 Crossfire has been known to compile on a wide variety of 52 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 53 compile and most all ISO C++ 200x and POSIX compliant systems.
28 compliant systems.
29 54
30 To get directions on compilation for UNIX/LINUX, read the INSTALL file. 55 To get directions on compilation for UNIX/LINUX, read the INSTALL file.
31 For Win9x, read INSTALL_WIN32.txt.
32 56
33USAGE 57USAGE
34 58
35 Crossfire runs on a client/server model. You will also need the 59 Crossfire runs on a client/server model. You will also need the client
36 client to play. You can either connect to a server someone else 60 to play. You can either connect to a server someone else has set up,
37 has set up, or run your own server and connect to that. The 61 or run your own server and connect to that. The client package has
38 client package has information for connecting to servers. 62 information for connecting to servers.
39 63
40 To run your own server, you need to make the crossfire binaries and install 64 To run your own server, you need to make the crossfire binaries
41 them, and then run the crossfire program. This now creates a server which 65 and install them, and then run the crossfire program. This now
42 you/other people can connect to. The map files will need to get downloaded 66 creates a server which you/other people can connect to. The map
43 and installed for the server to run properly. The maps should be 67 files will need to get downloaded and installed for the server to run
68 properly. The map pack is released together with the server and can be
69 downloaded form the same location. The maps should be copied into the
44 unpacked in the $(TARGET)/share/crossfire directory - after unpacking, 70 $(TARGET)/share/crossfire/maps directory - after unpacking, you should
45 you should have a $(TARGET)/share/crossfire/maps directory. 71 have a $(TARGET)/share/crossfire/maps/scorn directory.
46 72
47 If you plan to run a long term server, you should use one of the scripts 73 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. 74 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
60
61FTP SITES
62
63 FTP-sites where you can look for the latest versions are:
64
65 http://prdownloads.sourceforge.net/crossfire/
66 ftp://ftp.real-time.com/pub/games/crossfire
67
68 Changes made since the latest release can be found at the CVS
69 repository. Information on anonymous CVS access as
70 the download CVS snapshots and browsing the repository can be
71 found at:
72 http://sourceforge.net/cvs/?group_id=13833
73
74 75
75WEB SITES: 76WEB SITES:
76 77
77 The following web addresses have crossfire information that you may find 78 The following web addresses have crossfire information that you may find
78 useful: 79 useful:
79 80
80 http://crossfire.real-time.com/ 81 http://crossfire.schmorp.de/ (The main site)
81 real-time is the main crossfire site. 82
83 http://crossfire.real-time.com/ (The website for the old Crossfire game)
82 84
83 85
84REPORTING BUGS 86REPORTING BUGS
85 87
86 First, check the INSTALL file for common problems, and see if yours is 88 First, check the INSTALL file for common problems, and see if yours is
87 mentioned. 89 mentioned.
88 90
89 Bugs should be filed at the sourceforge web site: 91 Bugs should be filed using the following email address:
90 http://sourceforge.net/cvs/?group_id=13833 92 crossfire@schmorp.de
91 93
92 When reporting bugs, make sure you include the following: 94 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? 95 o What version of crossfire did you use?
97 o What type of computer did you use (CPU type) 96 o What type of computer did you use (CPU type)
98 o What is the version of the OS? 97 o What is the version of the OS?
99 o What windowing system are you using (Ie, openwindows, X11R6, etc) 98 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)? 99 o What compiler (and its version) did you use (e.g. gcc, acc)?
101 o Which flags did you give it? 100 o Which flags did you give it?
102 o If the bug happens when compiling crossfire, send an EXACT copy of 101 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 102 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. 103 sort 'it failed with a line like ...' doesn't help any.
105 o If the bug happened while running crossfire: 104 o If the bug happened while running crossfire:
106 - Include any output before to the bug. 105 - Include any output before to the bug.
107 - Give a description of what you did before the bug occured. The better 106 - Give a description of what you did before the bug occured. The better
108 detailed the description, the better chance I have of figuring 107 detailed the description, the better chance I have of figuring
109 out where the bug happened, or how I can recreate the bug. 108 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 109 - If possible, a stack trace from gdb (or other debugger) is very
111 helpful. 110 helpful.
112 111
113The more information provided, the better chance of the bug being fixed in 112The more information provided, the better chance of the bug being fixed in
114a timely fashion. 113a timely fashion.
115 114
116Further debugging informatiion can be found at
117http://crossfire.real-time.com/debugging_tips.html
118
119------------------------------------------------------------------------------ 115------------------------------------------------------------------------------
120SUBMITTING PATCHES: See the doc/programming_guide file. 116SUBMITTING PATCHES:
121 The patches should be submitted to the patch tracker on sourceforge: 117Patches should be submitted to email address:
122 http://sourceforge.net/cvs/?group_id=13833 118 crossfire@schmorp.de
123 119
124PUBLIC SERVERS: 120PUBLIC SERVERS:
125 121
126The best way to find a server to play is to run the client. It will contact 122The best way to find a server to play is to run the client. It will contact
127the metaserver and present a list to choose from. You can also see 123the metaserver and present a list to choose from. You can also see
128a list at http://crossfire.real-time.com/metaserver/ 124a list at http://crossfire.real-time.com/metaserver/
129 125
130 126
131COPYRIGHT 127COPYRIGHT
132 128
133 Don't get scared by the below, it's included just for "safety" reasons 8) 129 Copyright (C) 2007 Crossfire Development Team
134 (Don't want anyone to start selling the game)
135
136 Copyright (C) 2000,2006 Mark Wedel 130 Copyright (C) 2000, 2006 Mark Wedel
137 Copyright (C) 1992 Frank Tore Johansen 131 Copyright (C) 1992 Frank Tore Johansen
138 132
139 This program is free software; you can redistribute it and/or modify 133 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 134 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 135 the Free Software Foundation; either version 2 of the License, or
… …
148 142
149 You should have received a copy of the GNU General Public License 143 You should have received a copy of the GNU General Public License
150 along with this program; if not, write to the Free Software 144 along with this program; if not, write to the Free Software
151 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. 145 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
152 146
153 The author can be reached via e-mail to crossfire@schmorp.de 147 The authors can be reached via e-mail to crossfire@schmorp.de

Diff Legend

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