[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                 **SEE IMPORTANT NOTICE BELOW**
     - 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

  **NOTICE**: Crossfire uses an alternative signal stack, so you have to
  use either the "u"context method 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
     - 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.11
Committed:	Wed May 2 05:47:35 2007 UTC (17 years ago) by root
Branch:	MAIN
Changes since 1.10:	+4 -1 lines
Log Message:	* empty log message *
#	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.11	- Coro >= v3.62 SEE IMPORTANT NOTICE BELOW
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.11	NOTICE: Crossfire uses an alternative signal stack, so you have to
41			use either the "u"context method or "a"ssembly when configuring Coro.
42
43	root	1.5	Furthermore, you will need the following programs and libraries:
44	pippijn	1.4
45	root	1.7	- gperf, the GNU perfect hash generator >= v3.0
46	pippijn	1.4	- glib-2.0 >= v2.10
47			- libpng >= v1.2
48	root	1.7	- ImageMagick >= v6.0
49			- optipng => v0.5.5 (http://optipng.sf.net)
50	root	1.9	- pngnq >= 0.4 (http://freshmeat.net/redir/pngnq/53146/url_homepage/pngnq.html)
51	root	1.7	- rsync >= 2.6 (a must have anyways)
52	pippijn	1.4
53	root	1.5	Your compiler must support the Library Technical Report 1 extensions and
54			the upcoming typeof extension. The GNU C++ compiler >= version 4.0 does
55	root	1.6	support all these.
56	pippijn	1.4
57	root	1.9	On Debian GNU/Linux, you might get away with something like this for many of the
58			above dependencies:
59
60			apt-get install gperf optipng pngnq rsync imagemagick libglib2.0-dev libpng12-dev
61			apt-get install libpod-pom-perl libsafe-hole-perl libevent-perl
62
63	root	1.8
64	root	1.1	COMPILING
65
66	root	1.8	Crossfire has been known to compile on a wide variety of systems. It should
67			compile and run on most ISO C++ 200x and POSIX compliant systems.
68
69			To get generic directions on compilation, read the INSTALL file.
70
71	root	1.1
72	root	1.8	INSTALLATION/USAGE
73	root	1.1
74	root	1.8	Crossfire runs on a client/server model. You will also a client to
75			play. You can either connect to a server someone else has set up, or
76			run your own server and connect to that. There are a number of clients
77			available, but the recommended one is CFPlus (see below for URL).
78	root	1.1
79	root	1.8	To run your own server, you need to make the crossfire binaries and
80			install them, and then run the crossfire program. This now creates a
81			server which you/other people can connect to. First you have to download
82			and install maps and archetype packs, though.
83
84			Download both the cfmaps-<version> and cfarch-<version> archives, then use cfutil
85			to install both:
86
87			cfutil --install-maps path/to/cfmaps-<version>/
88			cfutil --install-arch path/to/cfarch-<version>/
89
90			Both processes can take some time, depending on your resources :)
91	root	1.2
92	root	1.1
93			WEB SITES:
94
95			The following web addresses have crossfire information that you may find
96			useful:
97
98	pippijn	1.4	http://crossfire.schmorp.de/ (The main site)
99
100			http://crossfire.real-time.com/ (The website for the old Crossfire game)
101	root	1.1
102
103			REPORTING BUGS
104
105			First, check the INSTALL file for common problems, and see if yours is
106			mentioned.
107
108	pippijn	1.4	Bugs should be filed using the following email address:
109			crossfire@schmorp.de
110	root	1.1
111			When reporting bugs, make sure you include the following:
112			o What version of crossfire did you use?
113	root	1.2	o What type of computer did you use (CPU type)
114			o What is the version of the OS?
115	pippijn	1.4	o What windowing system are you using (e.g. openwindows, X.org, XFree86)
116			o What compiler (and its version) did you use (e.g. gcc, acc)?
117	root	1.1	o Which flags did you give it?
118	pippijn	1.4	o If the bug happens when compiling crossfire, send an EXACT copy of the
119			compiler line, as well as the errors it puts out. Sending bugs of the
120			sort 'it failed with a line like ...' doesn't help any.
121	root	1.1	o If the bug happened while running crossfire:
122			- Include any output before to the bug.
123			- Give a description of what you did before the bug occured. The better
124	pippijn	1.4	detailed the description, the better chance I have of figuring
125			out where the bug happened, or how I can recreate the bug.
126	root	1.2	- If possible, a stack trace from gdb (or other debugger) is very
127			helpful.
128	root	1.1
129	root	1.2	The more information provided, the better chance of the bug being fixed in
130			a timely fashion.
131	root	1.1
132	pippijn	1.4	SUBMITTING PATCHES:
133	root	1.8
134			Patches should be submitted to email address:
135			crossfire@schmorp.de
136	root	1.1
137			PUBLIC SERVERS:
138
139	root	1.8	The best way to find a server to play is to run the client
140			and hit "Server List" in the setup dialog (this varies
141			depending on your client). You can also see a list at
142			http://crossfire.real-time.com/metaserver/.
143	root	1.1
144	root	1.8	The canonical server for use with Crossfire and CFPlus is
145			crossfire.schmorp.de, port 13327 (default).
146	root	1.1
147			COPYRIGHT
148
149	pippijn	1.4	Copyright (C) 2007 Crossfire Development Team
150			Copyright (C) 2000, 2006 Mark Wedel
151	root	1.1	Copyright (C) 1992 Frank Tore Johansen
152
153			This program is free software; you can redistribute it and/or modify
154			it under the terms of the GNU General Public License as published by
155			the Free Software Foundation; either version 2 of the License, or
156			(at your option) any later version.
157
158			This program is distributed in the hope that it will be useful,
159			but WITHOUT ANY WARRANTY; without even the implied warranty of
160			MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
161			GNU General Public License for more details.
162
163			You should have received a copy of the GNU General Public License
164			along with this program; if not, write to the Free Software
165			Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
166
167	pippijn	1.4	The authors can be reached via e-mail to crossfire@schmorp.de