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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines