[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 >= v2.52
     - BDB >= v0.1                   **libdb4.5, libdb4.4 might work**
     - Compress::LZF >= v1.8
     - Coro >= v3.64                 **SEE IMPORTANT NOTICE BELOW**
     - Coro::Event >= v2.1
     - Crossfire >= v0.99
     - Digest::MD5 >= v2.0
     - Event >= v1.08
     - IO::AIO >= v2.4
     - JSON::XS => v1.41
     - Pod::POM >= v0.17
     - Safe::Hole >= v0.10
     - Storable >= v2.0
     - Time::HiRes >= v1.0
     - YAML::Syck >= v0.71
     - YAML => v0.62

  **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 >= v0.4 (http://freshmeat.net/redir/pngnq/53146/url_homepage/pngnq.html)
     - rsync >= v2.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 get 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
  first, which will keep costly-to-generate files around for further runs
  of cfutil:

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

  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

  Most files in this distribution are covered by the GNU General Public
  License, version 3 (COPYING.GPL), or any later version, with the
  exception of ext/affero.ext, which is covered by the GNU Affero General
  Public License, Version 3 (COPYING.Affero). Please take note of the
  special requirements of the Affero license with respect to network
  servers and configure your network server according to the instructions
  given in ext/affero.ext.


CONTACT

  The authors can be reached via e-mail to crossfire@schmorp.de

Revision:	1.23
Committed:	Sat Aug 18 17:33:53 2007 UTC (16 years, 8 months ago) by root
Branch:	MAIN
Changes since 1.22:	+1 -1 lines
Log Message:	move some code to Coro
#	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.20	- AnyEvent >= v2.52
28			- BDB >= v0.1 libdb4.5, libdb4.4 might work
29	root	1.12	- Compress::LZF >= v1.8
30	root	1.23	- Coro >= v3.64 SEE IMPORTANT NOTICE BELOW
31	pippijn	1.4	- Coro::Event >= v2.1
32	root	1.16	- Crossfire >= v0.99
33	root	1.9	- Digest::MD5 >= v2.0
34	pippijn	1.4	- Event >= v1.08
35	root	1.20	- IO::AIO >= v2.4
36			- JSON::XS => v1.41
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	root	1.21	- YAML => v0.62
43	pippijn	1.4
44	root	1.11	NOTICE: Crossfire uses an alternative signal stack, so you have to
45	root	1.14	use either the "u"context method (slow) or "a"ssembly when configuring Coro.
46	root	1.11
47	root	1.5	Furthermore, you will need the following programs and libraries:
48	pippijn	1.4
49	root	1.7	- gperf, the GNU perfect hash generator >= v3.0
50	pippijn	1.4	- glib-2.0 >= v2.10
51			- libpng >= v1.2
52	root	1.12	- ImageMagick >= v6.0 (possibly higher, depending on its bugs)
53	root	1.7	- optipng => v0.5.5 (http://optipng.sf.net)
54	root	1.20	- pngnq >= v0.4 (http://freshmeat.net/redir/pngnq/53146/url_homepage/pngnq.html)
55			- rsync >= v2.6 (a must have anyways)
56	pippijn	1.4
57	root	1.5	Your compiler must support the Library Technical Report 1 extensions and
58			the upcoming typeof extension. The GNU C++ compiler >= version 4.0 does
59	root	1.6	support all these.
60	pippijn	1.4
61	root	1.9	On Debian GNU/Linux, you might get away with something like this for many of the
62			above dependencies:
63
64			apt-get install gperf optipng pngnq rsync imagemagick libglib2.0-dev libpng12-dev
65			apt-get install libpod-pom-perl libsafe-hole-perl libevent-perl
66
67	root	1.15	If you want to get sensible backtraces for error conditions at runtime
68	root	1.13	to be logged you also need the external addr2line program (part of GNU
69			binutils) in your PATH.
70
71	root	1.8
72	root	1.1	COMPILING
73
74	root	1.8	Crossfire has been known to compile on a wide variety of systems. It should
75			compile and run on most ISO C++ 200x and POSIX compliant systems.
76
77			To get generic directions on compilation, read the INSTALL file.
78
79	root	1.1
80	root	1.8	INSTALLATION/USAGE
81	root	1.1
82	root	1.8	Crossfire runs on a client/server model. You will also a client to
83			play. You can either connect to a server someone else has set up, or
84			run your own server and connect to that. There are a number of clients
85			available, but the recommended one is CFPlus (see below for URL).
86	root	1.1
87	root	1.12	To run your own server, you need to build the crossfire server binaries
88			and install them, then you will have to download and install map and
89			archetype packs:
90
91			Download both the cfmaps-<version> and cfarch-<version> archives, then
92			use cfutil to install both (the source directories must be writable for
93			this to work):
94	root	1.8
95			cfutil --install-maps path/to/cfmaps-<version>/
96			cfutil --install-arch path/to/cfarch-<version>/
97
98	root	1.12	Both processes can take some time, depending on your resources :) If you
99			plan to repeat the installation you should specify the --cache option
100	root	1.22	first, which will keep costly-to-generate files around for further runs
101			of cfutil:
102
103			cfutil --cache --install-maps path/to/cfmaps-<version>/
104			cfutil --cache --install-arch path/to/cfarch-<version>/
105	root	1.12
106			Atfer this you can then run the crossfire executable. This starts a
107			server which you/other people can connect to.
108	root	1.2
109	root	1.1
110	root	1.18	WEB SITES
111	root	1.1
112			The following web addresses have crossfire information that you may find
113			useful:
114
115	pippijn	1.4	http://crossfire.schmorp.de/ (The main site)
116
117			http://crossfire.real-time.com/ (The website for the old Crossfire game)
118	root	1.1
119
120			REPORTING BUGS
121
122			First, check the INSTALL file for common problems, and see if yours is
123			mentioned.
124
125	pippijn	1.4	Bugs should be filed using the following email address:
126			crossfire@schmorp.de
127	root	1.1
128			When reporting bugs, make sure you include the following:
129	root	1.12
130			* What version of crossfire did you use?
131			* What type of computer did you use (CPU type)
132			* What is the version of the OS?
133			* What windowing system are you using (e.g. openwindows, X.org, XFree86)
134			* What compiler (and its version) did you use (e.g. gcc, acc)?
135			* Which flags did you give it?
136			* If the bug happens when compiling crossfire, send an EXACT copy of the
137	pippijn	1.4	compiler line, as well as the errors it puts out. Sending bugs of the
138			sort 'it failed with a line like ...' doesn't help any.
139	root	1.12	* If the bug happened while running crossfire:
140	root	1.1	- Include any output before to the bug.
141	root	1.12	- Give a description of what you did before the bug occured. The better
142			detailed the description, the better chance we have of figuring
143			out where the bug happened, or how we can recreate the bug.
144	root	1.2	- If possible, a stack trace from gdb (or other debugger) is very
145			helpful.
146	root	1.1
147	root	1.12	The more information provided, the better chance of the bug being fixed
148			in a timely fashion.
149	root	1.1
150	root	1.18
151			SUBMITTING PATCHES
152	root	1.8
153	root	1.12	Patches should be submitted to email address:
154	root	1.18	crossfire@schmorp.de
155
156	root	1.1
157	root	1.18	PUBLIC SERVERS
158	root	1.1
159	root	1.12	The best way to find a server to play is to run the client
160			and hit "Server List" in the setup dialog (this varies
161			depending on your client). You can also see a list at
162			http://crossfire.real-time.com/metaserver/.
163	root	1.1
164	root	1.12	The canonical server for use with Crossfire and CFPlus is
165			crossfire.schmorp.de, port 13327 (default).
166	root	1.1
167	root	1.18
168	root	1.1	COPYRIGHT
169
170	root	1.18	Most files in this distribution are covered by the GNU General Public
171			License, version 3 (COPYING.GPL), or any later version, with the
172			exception of ext/affero.ext, which is covered by the GNU Affero General
173			Public License, Version 3 (COPYING.Affero). Please take note of the
174			special requirements of the Affero license with respect to network
175			servers and configure your network server according to the instructions
176			given in ext/affero.ext.
177
178
179			CONTACT
180	root	1.1
181	root	1.12	The authors can be reached via e-mail to crossfire@schmorp.de
182	root	1.18