[ViewVC] Annotation of: cvs/deliantra/server/README

WHAT IS CROSSFIRE?

  This is a multiplayer graphical arcade and adventure game, that runs on
  a client/server model. There are clients for Microsoft(R) Windows(TM)
  and POSIX systems such as Linux and *BSD. To get the most joyful
  experience, the Crossfire+ client should be used. This client is written
  in Perl and utilises SDL with OpenGL to provide you with the most
  immersive gameplay.

  Crossfire has certain flavours from other games, especially Gauntlet (TM)
  and Nethack/Moria.

  Any number of players can move around in their own window on the
  world, finding and using items and battle monsters. They can choose to
  cooperate or compete in the same "world".


REQUIREMENTS

  For UNIX, a modern C++ compiler with some extensions is required to
  compile this game (g++ 4.x works). In addition, you will need the Perl
  development libraries along with the following Perl modules (the server
  is tested with perl 5.8.8 and 5.8-maint) and their dependencies. (the
  minimum versions below may not be up-to-date, the configure script will
  check them all, though).

     - AnyEvent >= 2.52
     - BDB >= v0.1
     - Compress::LZF >= v1.8
     - Coro >= v3.62                 **SEE IMPORTANT NOTICE BELOW**
     - Coro::Event >= v2.1
     - Crossfire >= v0.98
     - Digest::MD5 >= v2.0
     - Event >= v1.08
     - IO::AIO >= 2.32
     - JSON::XS => 1.21
     - Pod::POM >= v0.17
     - Safe::Hole >= v0.10
     - Storable >= v2.0
     - Time::HiRes >= v1.0
     - YAML::Syck >= v0.71

  **NOTICE**: Crossfire uses an alternative signal stack, so you have to
  use either the "u"context method (slow) or "a"ssembly when configuring Coro.

  Furthermore, you will need the following programs and libraries:

     - gperf, the GNU perfect hash generator >= v3.0
     - glib-2.0 >= v2.10
     - libpng >= v1.2
     - ImageMagick >= v6.0 (possibly higher, depending on its bugs)
     - optipng => v0.5.5 (http://optipng.sf.net)
     - pngnq >= 0.4 (http://freshmeat.net/redir/pngnq/53146/url_homepage/pngnq.html)
     - rsync >= 2.6 (a must have anyways)

  Your compiler must support the Library Technical Report 1 extensions and
  the upcoming typeof extension. The GNU C++ compiler >= version 4.0 does
  support all these.

  On Debian GNU/Linux, you might get away with something like this for many of the
  above dependencies:

  apt-get install gperf optipng pngnq rsync imagemagick libglib2.0-dev libpng12-dev
  apt-get install libpod-pom-perl libsafe-hole-perl libevent-perl

  If you want to gte sensible backtraces for error conditions at runtime
  to be logged you also need the external addr2line program (part of GNU
  binutils) in your PATH.


COMPILING

  Crossfire has been known to compile on a wide variety of systems. It should
  compile and run on most ISO C++ 200x and POSIX compliant systems.

  To get generic directions on compilation, read the INSTALL file.


INSTALLATION/USAGE

  Crossfire runs on a client/server model. You will also a client to
  play. You can either connect to a server someone else has set up, or
  run your own server and connect to that. There are a number of clients
  available, but the recommended one is CFPlus (see below for URL).

  To run your own server, you need to build the crossfire server binaries
  and install them, then you will have to download and install map and
  archetype packs:

  Download both the cfmaps-<version> and cfarch-<version> archives, then
  use cfutil to install both (the source directories must be writable for
  this to work):

  cfutil --install-maps path/to/cfmaps-<version>/
  cfutil --install-arch path/to/cfarch-<version>/

  Both processes can take some time, depending on your resources :) If you
  plan to repeat the installation you should specify the --cache option
  which will keep costly-to-generate files around for further runs of
  cfutil.

  Atfer this you can then run the crossfire executable. This starts a
  server which you/other people can connect to.


WEB SITES:

  The following web addresses have crossfire information that you may find
  useful:

  http://crossfire.schmorp.de/ (The main site)

  http://crossfire.real-time.com/ (The website for the old Crossfire game)


REPORTING BUGS

  First, check the INSTALL file for common problems, and see if yours is
  mentioned.

  Bugs should be filed using the following email address:
     crossfire@schmorp.de

  When reporting bugs, make sure you include the following:

  * What version of crossfire did you use?
  * What type of computer did you use (CPU type)
  * What is the version of the OS?
  * What windowing system are you using (e.g. openwindows, X.org, XFree86)
  * What compiler (and its version) did you use (e.g. gcc, acc)?
  * Which flags did you give it?
  * If the bug happens when compiling crossfire, send an EXACT copy of the
    compiler line, as well as the errors it puts out.  Sending bugs of the
    sort 'it failed with a line like ...' doesn't help any.
  * If the bug happened while running crossfire:
    - Include any output before to the bug.
    - Give a description of what you did before the bug occured. The better
      detailed the description, the better chance we have of figuring
      out where the bug happened, or how we can recreate the bug.
    - If possible, a stack trace from gdb (or other debugger) is very
      helpful.

  The more information provided, the better chance of the bug being fixed
  in a timely fashion.

SUBMITTING PATCHES:

  Patches should be submitted to email address:
     crossfire@schmorp.de

PUBLIC SERVERS:

  The best way to find a server to play is to run the client
  and hit "Server List" in the setup dialog (this varies
  depending on your client). You can also see a list at
  http://crossfire.real-time.com/metaserver/.

  The canonical server for use with Crossfire and CFPlus is
  crossfire.schmorp.de, port 13327 (default).

COPYRIGHT

  Copyright (C) 2006,2007 Crossfire TRT Development Team
  Copyright (C) 2000,2006 Mark Wedel
  Copyright (C) 1992 Frank Tore Johansen

  This program is free software; you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation; either version 2 of the License, or
  (at your option) any later version.

  This program is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with this program; if not, write to the Free Software
  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

  The authors can be reached via e-mail to crossfire@schmorp.de
Revision:	1.14
Committed:	Sun May 27 02:26:17 2007 UTC (16 years, 11 months ago) by root
Branch:	MAIN
Changes since 1.13:	+2 -2 lines
Log Message:	2.1 cleanups
#	User	Rev	Content
1	root	1.1	WHAT IS CROSSFIRE?
2
3	root	1.8	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	root	1.1
10	pippijn	1.4	Crossfire has certain flavours from other games, especially Gauntlet (TM)
11	root	1.1	and Nethack/Moria.
12
13	root	1.8	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	root	1.1
18			REQUIREMENTS
19
20	root	1.5	For UNIX, a modern C++ compiler with some extensions is required to
21	root	1.12	compile this game (g++ 4.x works). In addition, you will need the Perl
22			development libraries along with the following Perl modules (the server
23			is tested with perl 5.8.8 and 5.8-maint) and their dependencies. (the
24			minimum versions below may not be up-to-date, the configure script will
25			check them all, though).
26	pippijn	1.4
27	root	1.12	- AnyEvent >= 2.52
28	root	1.9	- BDB >= v0.1
29	root	1.12	- Compress::LZF >= v1.8
30	root	1.14	- Coro >= v3.62 SEE IMPORTANT NOTICE BELOW
31	pippijn	1.4	- Coro::Event >= v2.1
32	root	1.12	- Crossfire >= v0.98
33	root	1.9	- Digest::MD5 >= v2.0
34	pippijn	1.4	- Event >= v1.08
35			- IO::AIO >= 2.32
36	root	1.12	- JSON::XS => 1.21
37	root	1.9	- Pod::POM >= v0.17
38			- Safe::Hole >= v0.10
39	pippijn	1.4	- Storable >= v2.0
40			- Time::HiRes >= v1.0
41			- YAML::Syck >= v0.71
42
43	root	1.11	NOTICE: Crossfire uses an alternative signal stack, so you have to
44	root	1.14	use either the "u"context method (slow) or "a"ssembly when configuring Coro.
45	root	1.11
46	root	1.5	Furthermore, you will need the following programs and libraries:
47	pippijn	1.4
48	root	1.7	- gperf, the GNU perfect hash generator >= v3.0
49	pippijn	1.4	- glib-2.0 >= v2.10
50			- libpng >= v1.2
51	root	1.12	- ImageMagick >= v6.0 (possibly higher, depending on its bugs)
52	root	1.7	- optipng => v0.5.5 (http://optipng.sf.net)
53	root	1.9	- pngnq >= 0.4 (http://freshmeat.net/redir/pngnq/53146/url_homepage/pngnq.html)
54	root	1.7	- rsync >= 2.6 (a must have anyways)
55	pippijn	1.4
56	root	1.5	Your compiler must support the Library Technical Report 1 extensions and
57			the upcoming typeof extension. The GNU C++ compiler >= version 4.0 does
58	root	1.6	support all these.
59	pippijn	1.4
60	root	1.9	On Debian GNU/Linux, you might get away with something like this for many of the
61			above dependencies:
62
63			apt-get install gperf optipng pngnq rsync imagemagick libglib2.0-dev libpng12-dev
64			apt-get install libpod-pom-perl libsafe-hole-perl libevent-perl
65
66	root	1.13	If you want to gte sensible backtraces for error conditions at runtime
67			to be logged you also need the external addr2line program (part of GNU
68			binutils) in your PATH.
69
70	root	1.8
71	root	1.1	COMPILING
72
73	root	1.8	Crossfire has been known to compile on a wide variety of systems. It should
74			compile and run on most ISO C++ 200x and POSIX compliant systems.
75
76			To get generic directions on compilation, read the INSTALL file.
77
78	root	1.1
79	root	1.8	INSTALLATION/USAGE
80	root	1.1
81	root	1.8	Crossfire runs on a client/server model. You will also a client to
82			play. You can either connect to a server someone else has set up, or
83			run your own server and connect to that. There are a number of clients
84			available, but the recommended one is CFPlus (see below for URL).
85	root	1.1
86	root	1.12	To run your own server, you need to build the crossfire server binaries
87			and install them, then you will have to download and install map and
88			archetype packs:
89
90			Download both the cfmaps-<version> and cfarch-<version> archives, then
91			use cfutil to install both (the source directories must be writable for
92			this to work):
93	root	1.8
94			cfutil --install-maps path/to/cfmaps-<version>/
95			cfutil --install-arch path/to/cfarch-<version>/
96
97	root	1.12	Both processes can take some time, depending on your resources :) If you
98			plan to repeat the installation you should specify the --cache option
99			which will keep costly-to-generate files around for further runs of
100			cfutil.
101
102			Atfer this you can then run the crossfire executable. This starts a
103			server which you/other people can connect to.
104	root	1.2
105	root	1.1
106			WEB SITES:
107
108			The following web addresses have crossfire information that you may find
109			useful:
110
111	pippijn	1.4	http://crossfire.schmorp.de/ (The main site)
112
113			http://crossfire.real-time.com/ (The website for the old Crossfire game)
114	root	1.1
115
116			REPORTING BUGS
117
118			First, check the INSTALL file for common problems, and see if yours is
119			mentioned.
120
121	pippijn	1.4	Bugs should be filed using the following email address:
122			crossfire@schmorp.de
123	root	1.1
124			When reporting bugs, make sure you include the following:
125	root	1.12
126			* What version of crossfire did you use?
127			* What type of computer did you use (CPU type)
128			* What is the version of the OS?
129			* What windowing system are you using (e.g. openwindows, X.org, XFree86)
130			* What compiler (and its version) did you use (e.g. gcc, acc)?
131			* Which flags did you give it?
132			* If the bug happens when compiling crossfire, send an EXACT copy of the
133	pippijn	1.4	compiler line, as well as the errors it puts out. Sending bugs of the
134			sort 'it failed with a line like ...' doesn't help any.
135	root	1.12	* If the bug happened while running crossfire:
136	root	1.1	- Include any output before to the bug.
137	root	1.12	- Give a description of what you did before the bug occured. The better
138			detailed the description, the better chance we have of figuring
139			out where the bug happened, or how we can recreate the bug.
140	root	1.2	- If possible, a stack trace from gdb (or other debugger) is very
141			helpful.
142	root	1.1
143	root	1.12	The more information provided, the better chance of the bug being fixed
144			in a timely fashion.
145	root	1.1
146	pippijn	1.4	SUBMITTING PATCHES:
147	root	1.8
148	root	1.12	Patches should be submitted to email address:
149			crossfire@schmorp.de
150	root	1.1
151			PUBLIC SERVERS:
152
153	root	1.12	The best way to find a server to play is to run the client
154			and hit "Server List" in the setup dialog (this varies
155			depending on your client). You can also see a list at
156			http://crossfire.real-time.com/metaserver/.
157	root	1.1
158	root	1.12	The canonical server for use with Crossfire and CFPlus is
159			crossfire.schmorp.de, port 13327 (default).
160	root	1.1
161			COPYRIGHT
162
163	root	1.12	Copyright (C) 2006,2007 Crossfire TRT Development Team
164			Copyright (C) 2000,2006 Mark Wedel
165			Copyright (C) 1992 Frank Tore Johansen
166
167			This program is free software; you can redistribute it and/or modify
168			it under the terms of the GNU General Public License as published by
169			the Free Software Foundation; either version 2 of the License, or
170			(at your option) any later version.
171
172			This program is distributed in the hope that it will be useful,
173			but WITHOUT ANY WARRANTY; without even the implied warranty of
174			MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
175			GNU General Public License for more details.
176
177			You should have received a copy of the GNU General Public License
178			along with this program; if not, write to the Free Software
179			Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
180	root	1.1
181	root	1.12	The authors can be reached via e-mail to crossfire@schmorp.de