[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. 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).

     - BDB >= v0.1
     - Compress::LZF >= v1.71
     - Coro >= v3.62
     - Coro::Event >= v2.1
     - Crossfire >= v0.97
     - Digest::MD5 >= v2.0
     - Event >= v1.08
     - IO::AIO >= 2.32
     - JSON::XS => 1.11
     - Pod::POM >= v0.17
     - Safe::Hole >= v0.10
     - Storable >= v2.0
     - Time::HiRes >= v1.0
     - YAML::Syck >= v0.71

  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
     - 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


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 make the crossfire binaries and
  install them, and then run the crossfire program. This now creates a
  server which you/other people can connect to. First you have to download
  and install maps and archetype packs, though.

  Download both the cfmaps-<version> and cfarch-<version> archives, then use cfutil
  to install both:

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

  Both processes can take some time, depending on your resources :)


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:
  o What version of crossfire did you use?
  o What type of computer did you use (CPU type)
  o What is the version of the OS?
  o What windowing system are you using (e.g. openwindows, X.org, XFree86)
  o What compiler (and its version) did you use (e.g. gcc, acc)?
  o Which flags did you give it?
  o 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.
  o 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 I have of figuring
      out where the bug happened, or how I 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) 2007 Crossfire 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.10
Committed:	Fri Apr 27 19:53:04 2007 UTC (17 years ago) by root
Branch:	MAIN
Changes since 1.9:	+1 -1 lines
Log Message:	revamp loggin. have a new log flag logBacktrace that logs the message and prepares a backtrace in the background, spewing it into the log at a later time. this is useful to shed some light on otherwise completely useless log messages such as: 2007-04-27 19:48:48.142 Calling random_roll with min=1 max=0 which could just as well not be there as we will never find out who is doing this to puny poor random_roll.
#	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			compile this game. In addition, you will need the Perl development
22			libraries along with the following Perl modules (the server is tested
23			with perl 5.8.8 and 5.8-maint).
24	pippijn	1.4
25	root	1.9	- BDB >= v0.1
26			- Compress::LZF >= v1.71
27	root	1.10	- Coro >= v3.62
28	pippijn	1.4	- Coro::Event >= v2.1
29	root	1.9	- Crossfire >= v0.97
30			- Digest::MD5 >= v2.0
31	pippijn	1.4	- Event >= v1.08
32			- IO::AIO >= 2.32
33	root	1.9	- JSON::XS => 1.11
34			- Pod::POM >= v0.17
35			- Safe::Hole >= v0.10
36	pippijn	1.4	- Storable >= v2.0
37			- Time::HiRes >= v1.0
38			- YAML::Syck >= v0.71
39
40	root	1.5	Furthermore, you will need the following programs and libraries:
41	pippijn	1.4
42	root	1.7	- gperf, the GNU perfect hash generator >= v3.0
43	pippijn	1.4	- glib-2.0 >= v2.10
44			- libpng >= v1.2
45	root	1.7	- ImageMagick >= v6.0
46			- optipng => v0.5.5 (http://optipng.sf.net)
47	root	1.9	- pngnq >= 0.4 (http://freshmeat.net/redir/pngnq/53146/url_homepage/pngnq.html)
48	root	1.7	- rsync >= 2.6 (a must have anyways)
49	pippijn	1.4
50	root	1.5	Your compiler must support the Library Technical Report 1 extensions and
51			the upcoming typeof extension. The GNU C++ compiler >= version 4.0 does
52	root	1.6	support all these.
53	pippijn	1.4
54	root	1.9	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
60	root	1.8
61	root	1.1	COMPILING
62
63	root	1.8	Crossfire has been known to compile on a wide variety of systems. It should
64			compile and run on most ISO C++ 200x and POSIX compliant systems.
65
66			To get generic directions on compilation, read the INSTALL file.
67
68	root	1.1
69	root	1.8	INSTALLATION/USAGE
70	root	1.1
71	root	1.8	Crossfire runs on a client/server model. You will also a client to
72			play. You can either connect to a server someone else has set up, or
73			run your own server and connect to that. There are a number of clients
74			available, but the recommended one is CFPlus (see below for URL).
75	root	1.1
76	root	1.8	To run your own server, you need to make the crossfire binaries and
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	root	1.2
89	root	1.1
90			WEB SITES:
91
92			The following web addresses have crossfire information that you may find
93			useful:
94
95	pippijn	1.4	http://crossfire.schmorp.de/ (The main site)
96
97			http://crossfire.real-time.com/ (The website for the old Crossfire game)
98	root	1.1
99
100			REPORTING BUGS
101
102			First, check the INSTALL file for common problems, and see if yours is
103			mentioned.
104
105	pippijn	1.4	Bugs should be filed using the following email address:
106			crossfire@schmorp.de
107	root	1.1
108			When reporting bugs, make sure you include the following:
109			o What version of crossfire did you use?
110	root	1.2	o What type of computer did you use (CPU type)
111			o What is the version of the OS?
112	pippijn	1.4	o What windowing system are you using (e.g. openwindows, X.org, XFree86)
113			o What compiler (and its version) did you use (e.g. gcc, acc)?
114	root	1.1	o Which flags did you give it?
115	pippijn	1.4	o If the bug happens when compiling crossfire, send an EXACT copy of the
116			compiler line, as well as the errors it puts out. Sending bugs of the
117			sort 'it failed with a line like ...' doesn't help any.
118	root	1.1	o If the bug happened while running crossfire:
119			- Include any output before to the bug.
120			- Give a description of what you did before the bug occured. The better
121	pippijn	1.4	detailed the description, the better chance I have of figuring
122			out where the bug happened, or how I can recreate the bug.
123	root	1.2	- If possible, a stack trace from gdb (or other debugger) is very
124			helpful.
125	root	1.1
126	root	1.2	The more information provided, the better chance of the bug being fixed in
127			a timely fashion.
128	root	1.1
129	pippijn	1.4	SUBMITTING PATCHES:
130	root	1.8
131			Patches should be submitted to email address:
132			crossfire@schmorp.de
133	root	1.1
134			PUBLIC SERVERS:
135
136	root	1.8	The best way to find a server to play is to run the client
137			and hit "Server List" in the setup dialog (this varies
138			depending on your client). You can also see a list at
139			http://crossfire.real-time.com/metaserver/.
140	root	1.1
141	root	1.8	The canonical server for use with Crossfire and CFPlus is
142			crossfire.schmorp.de, port 13327 (default).
143	root	1.1
144			COPYRIGHT
145
146	pippijn	1.4	Copyright (C) 2007 Crossfire Development Team
147			Copyright (C) 2000, 2006 Mark Wedel
148	root	1.1	Copyright (C) 1992 Frank Tore Johansen
149
150			This program is free software; you can redistribute it and/or modify
151			it under the terms of the GNU General Public License as published by
152			the Free Software Foundation; either version 2 of the License, or
153			(at your option) any later version.
154
155			This program is distributed in the hope that it will be useful,
156			but WITHOUT ANY WARRANTY; without even the implied warranty of
157			MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
158			GNU General Public License for more details.
159
160			You should have received a copy of the GNU General Public License
161			along with this program; if not, write to the Free Software
162			Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
163
164	pippijn	1.4	The authors can be reached via e-mail to crossfire@schmorp.de