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.2 by elmex, Wed Mar 15 14:04:31 2006 UTC vs.
Revision 1.45 by root, Sat Aug 30 05:19:03 2008 UTC

1WHAT IS CROSSFIRE? 1WHAT IS DELIANTRA?
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
4 the X-Windows environment. It runs on a client/server model. 4 a client/server model. There are clients for Microsoft(R) Windows(TM)
5 The client runs with X11, GTK, or SDL within a gtk window. A 5 and POSIX systems such as Linux and *BSD. To get the most joyful
6 windows client is available, and a java client is under development. 6 experience, the Deliantra 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.
7 9
8 It has certain flavours from other games, especially Gauntlet (TM) 10 Deliantra has certain flavours from other games, especially Gauntlet (TM)
9 and Nethack/Moria. 11 and Nethack/Moria.
10 12
11 Any number of players can move around in their own window, finding 13 Any number of players can move around in their own window on the
12 and using items and battle monsters. They can choose to cooperate 14 world, finding and using items and battle monsters. They can choose to
13 or compete in the same "world". 15 cooperate or compete in the same "world".
16
14 17
15REQUIREMENTS 18REQUIREMENTS
16 19
17 For UNIX, X-windows and an ANSI C compiler to compile this game. 20 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 21 compile this game (g++ 4.x works). In addition, you will need the Perl
19 map editor. 22 development libraries along with the following Perl modules (the server
23 requires perl 5.10). A perl configured for 64 bit integer support is
24 highly recommended to avoid overflows, but 32 bit perls are supported)
25 and their dependencies. In general, the newest version from CPAN will
26 do. The configure script will complain when it detects an unsuitable
27 version.
20 28
21 For Windows 9x, you need Visual C++ (or some other ANSI C 29 - AnyEvent
22 compiler that can read ".dsw"-files). 30 - AnyEvent::AIO
23 31 - AnyEvent::BDB
32 - BDB **compiled against libdb4.[567] (libdb4.4 *might* work)**
33 - Compress::LZF
34 - Coro **SEE IMPORTANT NOTICE BELOW**
35 - Coro::EV
36 - Deliantra
37 - Digest::MD5
38 - EV
39 - IO::AIO
40 - JSON::XS
41 - Net::IRC3
42 - Pod::POM
43 - Safe::Hole
44 - Storable
45 - Time::HiRes
46 - URI
47 - YAML
48 - YAML::Syck
49
50 **NOTICE**: Deliantra uses an alternative signal stack, so you have to
51 use either the "u"context method (slow) or "a"ssembly when configuring
52 Coro.
53
54 Furthermore, you will need the following programs and libraries:
55
56 - gperf, the GNU perfect hash generator >= v3.0
57 - glib-2.0 >= v2.10
58 - libpng >= v1.2
59 - ImageMagick >= v6.0 (possibly higher, depending on its bugs)
60 - optipng => v0.5.5 (http://optipng.sf.net)
61 - pngnq >= v0.4 (http://freshmeat.net/redir/pngnq/53146/url_homepage/pngnq.html)
62 - rsync >= v2.6 (a must have anyways)
63
64 Your compiler must support the Library Technical Report 1 extensions and
65 the upcoming typeof extension. The GNU C++ compiler >= version 4.0 does
66 support all these.
67
68 On Debian GNU/Linux, you might get away with something like this for many of the
69 above dependencies:
70
71 apt-get install gperf optipng pngnq rsync imagemagick libglib2.0-dev libpng12-dev
72 apt-get install libpod-pom-perl libsafe-hole-perl libevent-perl
73
74 If you want to get sensible backtraces for error conditions at runtime
75 to be logged you also need the external addr2line program (part of GNU
76 binutils) in your PATH.
77
78
24COMPILING 79COMPILING
25 80
26 Crossfire has been known to compile on a wide variety of 81 Deliantra 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 82 compile and run on most ISO C++ 200x and POSIX compliant systems.
28 compliant systems.
29 83
30 To get directions on compilation for UNIX/LINUX, read the INSTALL file. 84 To get generic directions on compilation, read the INSTALL file.
31 For Win9x, read INSTALL_WIN32.txt.
32
33USAGE
34
35 Crossfire runs on a client/server model. You will also need the
36 client to play. You can either connect to a server someone else
37 has set up, or run your own server and connect to that. The
38 client package has information for connecting to servers.
39
40 To run your own server, you need to make the crossfire binaries and install
41 them, and then run the crossfire program. This now creates a server which
42 you/other people can connect to. The map files will need to get downloaded
43 and installed for the server to run properly. The maps should be
44 unpacked in the $(TARGET)/share/crossfire directory - after unpacking,
45 you should have a $(TARGET)/share/crossfire/maps directory.
46
47 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.
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 85
60 86
61FTP SITES 87INSTALLATION/USAGE
62 88
63 FTP-sites where you can look for the latest versions are: 89 Deliantra runs on a client/server model. You will also a client to
90 play. You can either connect to a server someone else has set up, or
91 run your own server and connect to that. There are a number of clients
92 available, but the recommended one is CFPlus (see below for URL).
64 93
65 http://prdownloads.sourceforge.net/crossfire/ 94 To run your own server, you need to build the deliantra server binaries
66 ftp://ftp.real-time.com/pub/games/crossfire 95 and install them, then you will have to download and install map and
96 archetype packs:
67 97
68 Changes made since the latest release can be found at the CVS 98 Download both the cfmaps-<version> and cfarch-<version> archives, then
69 repository. Information on anonymous CVS access as 99 use cfutil to install both (the source directories must be writable for
70 the download CVS snapshots and browsing the repository can be 100 this to work):
71 found at: 101
72 http://sourceforge.net/cvs/?group_id=13833 102 cfutil --install-maps path/to/cfmaps-<version>/
103 cfutil --install-arch path/to/cfarch-<version>/
104
105 Both processes can take some time, depending on your resources :) If you
106 plan to repeat the installation you should specify the --cache option
107 first, which will keep costly-to-generate files around for further runs
108 of cfutil:
109
110 cfutil --cache --install-maps path/to/cfmaps-<version>/
111 cfutil --cache --install-arch path/to/cfarch-<version>/
112
113 Atfer this you can then run the deliantra executable. This starts a
114 server which you/other people can connect to.
73 115
74 116
75WEB SITES: 117WEB SITES
76 118
77 The following web addresses have crossfire information that you may find 119 The following web addresses have deliantra information that you may find
78 useful: 120 useful:
79 121
80 http://crossfire.real-time.com/ 122 http://www.deliantra.net/ (The main site)
81 real-time is the main crossfire site.
82 123
83 124
84REPORTING BUGS 125REPORTING BUGS
85 126
86 First, check the INSTALL file for common problems, and see if yours is 127 First, check the INSTALL file for common problems, and see if yours is
87 mentioned. 128 mentioned.
88 129
89 Bugs should be filed at the sourceforge web site: 130 Bugs should be filed using the following email address:
90 http://sourceforge.net/cvs/?group_id=13833 131 support@deliantra.net
91 132
92 When reporting bugs, make sure you include the following: 133 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 134
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? 135 * What version of deliantra did you use?
97 o What type of computer did you use (CPU type) 136 * What type of computer did you use (CPU type)
98 o What is the version of the OS? 137 * What is the version of the OS?
99 o What windowing system are you using (Ie, openwindows, X11R6, etc) 138 * 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)? 139 * What compiler (and its version) did you use (e.g. gcc, acc)?
101 o Which flags did you give it? 140 * Which flags did you give it?
102 o If the bug happens when compiling crossfire, send an EXACT copy of 141 * If the bug happens when compiling deliantra, send an EXACT copy of the
103 the compiler line, as well as the errors it puts out. Sending bugs 142 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. 143 sort 'it failed with a line like ...' doesn't help any.
105 o If the bug happened while running crossfire: 144 * If the bug happened while running deliantra:
106 - Include any output before to the bug. 145 - Include any output before to the bug.
107 - Give a description of what you did before the bug occured. The better 146 - Give a description of what you did before the bug occured. The better
108 detailed the description, the better chance I have of figuring 147 detailed the description, the better chance we have of figuring
109 out where the bug happened, or how I can recreate the bug. 148 out where the bug happened, or how we can recreate the bug.
110 - If possible, a stack trace from gdb (or other debugger) is very 149 - If possible, a stack trace from gdb (or other debugger) is very
111 helpful. 150 helpful.
112 151
113The more information provided, the better chance of the bug being fixed in 152 The more information provided, the better chance of the bug being fixed
114a timely fashion. 153 in a timely fashion.
115 154
116Further debugging informatiion can be found at
117http://crossfire.real-time.com/debugging_tips.html
118 155
119------------------------------------------------------------------------------ 156SUBMITTING PATCHES
120SUBMITTING PATCHES: See the doc/programming_guide file.
121 The patches should be submitted to the patch tracker on sourceforge:
122 http://sourceforge.net/cvs/?group_id=13833
123 157
124PUBLIC SERVERS: 158 Patches should be submitted to email address:
159 support@deliantra.net
125 160
161
162PUBLIC SERVERS
163
126The best way to find a server to play is to run the client. It will contact 164 The best way to find a server to play is to run the client
127the metaserver and present a list to choose from. You can also see 165 and hit "Server List" in the setup dialog (this varies
128a list at http://crossfire.real-time.com/metaserver/ 166 depending on your client).
167
168 The canonical server for use with Deliantra and CFPlus is
169 gameserver.deliantra.net, port 13327 (the default).
129 170
130 171
131COPYRIGHT 172COPYRIGHT
132 173
133 Don't get scared by the below, it's included just for "safety" reasons 8) 174 Most files in this distribution are covered by the GNU General Public
134 (Don't want anyone to start selling the game) 175 License, version 3 (COPYING.GPL), or any later version, with the
176 exception of ext/affero.ext, which is covered by the GNU Affero General
177 Public License, Version 3 (COPYING.Affero). Please take note of the
178 special requirements of the Affero license with respect to network
179 servers and configure your network server according to the instructions
180 given in ext/affero.ext.
135 181
136 Copyright (C) 2000,2006 Mark Wedel
137 Copyright (C) 1992 Frank Tore Johansen
138 182
139 This program is free software; you can redistribute it and/or modify 183CONTACT
140 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
142 (at your option) any later version.
143 184
144 This program is distributed in the hope that it will be useful, 185 The authors can be reached via e-mail to support@deliantra.net
145 but WITHOUT ANY WARRANTY; without even the implied warranty of
146 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
147 GNU General Public License for more details.
148 186
149 You should have received a copy of the GNU General Public License
150 along with this program; if not, write to the Free Software
151 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
152
153 The author can be reached via e-mail to crossfire-devel@real-time.com

Diff Legend

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