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

Comparing deliantra/server/README (file contents):
Revision 1.4 by pippijn, Mon Mar 5 19:34:20 2007 UTC vs.
Revision 1.10 by root, Fri Apr 27 19:53:04 2007 UTC

1WHAT IS CROSSFIRE? 1WHAT IS CROSSFIRE?
2 2
3 This is a multiplayer graphical arcade and adventure game, that runs on a 3 This is a multiplayer graphical arcade and adventure game, that runs on
4 client/server model. There are clients for Microsoft(R) Windows(TM) and 4 a client/server model. There are clients for Microsoft(R) Windows(TM)
5 POSIX systems such as Linux and *BSD. To get the most joyful experience, 5 and POSIX systems such as Linux and *BSD. To get the most joyful
6 the Crossfire+ client should be used. This client is written in Perl and 6 experience, the Crossfire+ client should be used. This client is written
7 utilises SDL with OpenGL. 7 in Perl and utilises SDL with OpenGL to provide you with the most
8 immersive gameplay.
8 9
9 Crossfire has certain flavours from other games, especially Gauntlet (TM) 10 Crossfire has certain flavours from other games, especially Gauntlet (TM)
10 and Nethack/Moria. 11 and Nethack/Moria.
11 12
12 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
13 and using items and battle monsters. They can choose to cooperate 14 world, finding and using items and battle monsters. They can choose to
14 or compete in the same "world". 15 cooperate or compete in the same "world".
16
15 17
16REQUIREMENTS 18REQUIREMENTS
17 19
18 For UNIX, the ISO C++ 200x compiler are required to compile this game. In 20 For UNIX, a modern C++ compiler with some extensions is required to
19 addition, you will need the Perl development libraries along with the 21 compile this game. In addition, you will need the Perl development
20 following Perl modules: 22 libraries along with the following Perl modules (the server is tested
23 with perl 5.8.8 and 5.8-maint).
21 24
25 - BDB >= v0.1
26 - Compress::LZF >= v1.71
27 - Coro >= v3.62
28 - Coro::Event >= v2.1
22 - Crossfire >= v0.97 29 - Crossfire >= v0.97
23 - Coro >= v3.5 30 - Digest::MD5 >= v2.0
24 - Coro::Event >= v2.1
25 - Event >= v1.08 31 - Event >= v1.08
26 - IO::AIO >= 2.32 32 - IO::AIO >= 2.32
27 - BDB >= v0.1 33 - JSON::XS => 1.11
34 - Pod::POM >= v0.17
35 - Safe::Hole >= v0.10
28 - Storable >= v2.0 36 - Storable >= v2.0
29 - Time::HiRes >= v1.0 37 - Time::HiRes >= v1.0
30 - YAML::Syck >= v0.71 38 - 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 39
36 Furthermore, to build the crossfire server you will need the following: 40 Furthermore, you will need the following programs and libraries:
37 41
38 - gperf, the GNU perfect hash generator 42 - gperf, the GNU perfect hash generator >= v3.0
39 - glib-2.0 >= v2.10 43 - glib-2.0 >= v2.10
40 - libpng >= v1.2 44 - libpng >= v1.2
45 - ImageMagick >= v6.0
46 - optipng => v0.5.5 (http://optipng.sf.net)
47 - pngnq >= 0.4 (http://freshmeat.net/redir/pngnq/53146/url_homepage/pngnq.html)
48 - rsync >= 2.6 (a must have anyways)
41 49
42 Your compiler must support the Library Technical Report 1 extensions. 50 Your compiler must support the Library Technical Report 1 extensions and
43 The GNU C++ compiler >= version 4.0 does support these. 51 the upcoming typeof extension. The GNU C++ compiler >= version 4.0 does
52 support all these.
53
54 On Debian GNU/Linux, you might get away with something like this for many of the
55 above dependencies:
56
57 apt-get install gperf optipng pngnq rsync imagemagick libglib2.0-dev libpng12-dev
58 apt-get install libpod-pom-perl libsafe-hole-perl libevent-perl
59
44 60
45COMPILING 61COMPILING
46 62
47 Crossfire has been known to compile on a wide variety of systems. It should 63 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. 64 compile and run on most ISO C++ 200x and POSIX compliant systems.
49 65
50 To get directions on compilation for UNIX/LINUX, read the INSTALL file. 66 To get generic directions on compilation, read the INSTALL file.
51 67
52USAGE
53 68
54 Crossfire runs on a client/server model. You will also need the client to 69INSTALLATION/USAGE
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 70
59 To run your own server, you need to make the crossfire binaries and install 71 Crossfire runs on a client/server model. You will also a client to
60 them, and then run the crossfire program. This now creates a server which 72 play. You can either connect to a server someone else has set up, or
61 you/other people can connect to. The map files will need to get downloaded 73 run your own server and connect to that. There are a number of clients
62 and installed for the server to run properly. The maps should be unpacked in 74 available, but the recommended one is CFPlus (see below for URL).
63 the $(TARGET)/share/crossfire directory - after unpacking, you should have a
64 $(TARGET)/share/crossfire/maps directory.
65 75
66 If you plan to run a long term server, you should use one of the scripts 76 To run your own server, you need to make the crossfire binaries and
67 provided that will re-run crossfire if it dies for some reason. 77 install them, and then run the crossfire program. This now creates a
78 server which you/other people can connect to. First you have to download
79 and install maps and archetype packs, though.
80
81 Download both the cfmaps-<version> and cfarch-<version> archives, then use cfutil
82 to install both:
83
84 cfutil --install-maps path/to/cfmaps-<version>/
85 cfutil --install-arch path/to/cfarch-<version>/
86
87 Both processes can take some time, depending on your resources :)
88
68 89
69WEB SITES: 90WEB SITES:
70 91
71 The following web addresses have crossfire information that you may find 92 The following web addresses have crossfire information that you may find
72 useful: 93 useful:
… …
103 helpful. 124 helpful.
104 125
105The more information provided, the better chance of the bug being fixed in 126The more information provided, the better chance of the bug being fixed in
106a timely fashion. 127a timely fashion.
107 128
108------------------------------------------------------------------------------
109SUBMITTING PATCHES: 129SUBMITTING PATCHES:
130
110Patches should be submitted to email address: 131 Patches should be submitted to email address:
111 crossfire@schmorp.de 132 crossfire@schmorp.de
112 133
113PUBLIC SERVERS: 134PUBLIC SERVERS:
114 135
115The best way to find a server to play is to run the client. It will contact 136 The best way to find a server to play is to run the client
116the metaserver and present a list to choose from. You can also see 137 and hit "Server List" in the setup dialog (this varies
138 depending on your client). You can also see a list at
117a list at http://crossfire.real-time.com/metaserver/ 139 http://crossfire.real-time.com/metaserver/.
118 140
141 The canonical server for use with Crossfire and CFPlus is
142 crossfire.schmorp.de, port 13327 (default).
119 143
120COPYRIGHT 144COPYRIGHT
121 145
122 Copyright (C) 2007 Crossfire Development Team 146 Copyright (C) 2007 Crossfire Development Team
123 Copyright (C) 2000, 2006 Mark Wedel 147 Copyright (C) 2000, 2006 Mark Wedel

Diff Legend

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