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

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

  Any number of players can move around in their own window, 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).

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

  Furthermore, you will need the following programs and libraries:

     - gperf, the GNU perfect hash generator
     - glib-2.0 >= v2.10
     - libpng >= v1.2
     - ImageMagick >= 6.0 (convert must be in your PATH).

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

COMPILING

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

  To get directions on compilation for UNIX/LINUX, read the INSTALL file.

USAGE

  Crossfire runs on a client/server model.  You will also need the client
  to play. You can either connect to a server someone else has set up,
  or run your own server and connect to that.  The client package has
  information for connecting to servers.

  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.  The map
  files will need to get downloaded and installed for the server to run
  properly.  The map pack is released together with the server and can be
  downloaded form the same location. The maps should be copied into the
  $(TARGET)/share/crossfire/maps directory - after unpacking, you should
  have a $(TARGET)/share/crossfire/maps/scorn directory.

  If you plan to run a long term server, you should use one of the scripts
  provided that will re-run crossfire if it dies for some reason.

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.  It will contact
the metaserver and present a list to choose from.  You can also see
a list at http://crossfire.real-time.com/metaserver/


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.5
Committed:	Mon Mar 5 22:06:50 2007 UTC (17 years, 2 months ago) by root
Branch:	MAIN
CVS Tags:	rel-2_0
Changes since 1.4:	+22 -17 lines
Log Message:	check for convert
#	User	Rev	Content
1	root	1.1	WHAT IS CROSSFIRE?
2
3	pippijn	1.4	This is a multiplayer graphical arcade and adventure game, that runs on a
4			client/server model. There are clients for Microsoft(R) Windows(TM) and
5			POSIX systems such as Linux and *BSD. To get the most joyful experience,
6			the Crossfire+ client should be used. This client is written in Perl and
7			utilises SDL with OpenGL.
8	root	1.1
9	pippijn	1.4	Crossfire has certain flavours from other games, especially Gauntlet (TM)
10	root	1.1	and Nethack/Moria.
11
12			Any number of players can move around in their own window, finding
13			and using items and battle monsters. They can choose to cooperate
14			or compete in the same "world".
15
16			REQUIREMENTS
17
18	root	1.5	For UNIX, a modern C++ compiler with some extensions is required to
19			compile this game. In addition, you will need the Perl development
20			libraries along with the following Perl modules (the server is tested
21			with perl 5.8.8 and 5.8-maint).
22	pippijn	1.4
23			- Crossfire >= v0.97
24			- Coro >= v3.5
25			- Coro::Event >= v2.1
26			- Event >= v1.08
27			- IO::AIO >= 2.32
28			- BDB >= v0.1
29			- Storable >= v2.0
30			- Time::HiRes >= v1.0
31			- YAML::Syck >= v0.71
32			- Digest::MD5 >= v2.0
33			- Compress::LZF >= v1.71
34			- Safe::Hole >= v0.10
35			- Pod::POM >= v0.17
36
37	root	1.5	Furthermore, you will need the following programs and libraries:
38	pippijn	1.4
39			- gperf, the GNU perfect hash generator
40			- glib-2.0 >= v2.10
41			- libpng >= v1.2
42	root	1.5	- ImageMagick >= 6.0 (convert must be in your PATH).
43	pippijn	1.4
44	root	1.5	Your compiler must support the Library Technical Report 1 extensions and
45			the upcoming typeof extension. The GNU C++ compiler >= version 4.0 does
46			support these.
47	pippijn	1.4
48	root	1.1	COMPILING
49
50	pippijn	1.4	Crossfire has been known to compile on a wide variety of systems. It should
51			compile and most all ISO C++ 200x and POSIX compliant systems.
52	root	1.1
53			To get directions on compilation for UNIX/LINUX, read the INSTALL file.
54
55			USAGE
56
57	root	1.5	Crossfire runs on a client/server model. You will also need the client
58			to play. You can either connect to a server someone else has set up,
59			or run your own server and connect to that. The client package has
60			information for connecting to servers.
61
62			To run your own server, you need to make the crossfire binaries
63			and install them, and then run the crossfire program. This now
64			creates a server which you/other people can connect to. The map
65			files will need to get downloaded and installed for the server to run
66			properly. The map pack is released together with the server and can be
67			downloaded form the same location. The maps should be copied into the
68			$(TARGET)/share/crossfire/maps directory - after unpacking, you should
69			have a $(TARGET)/share/crossfire/maps/scorn directory.
70	root	1.2
71			If you plan to run a long term server, you should use one of the scripts
72			provided that will re-run crossfire if it dies for some reason.
73	root	1.1
74			WEB SITES:
75
76			The following web addresses have crossfire information that you may find
77			useful:
78
79	pippijn	1.4	http://crossfire.schmorp.de/ (The main site)
80
81			http://crossfire.real-time.com/ (The website for the old Crossfire game)
82	root	1.1
83
84			REPORTING BUGS
85
86			First, check the INSTALL file for common problems, and see if yours is
87			mentioned.
88
89	pippijn	1.4	Bugs should be filed using the following email address:
90			crossfire@schmorp.de
91	root	1.1
92			When reporting bugs, make sure you include the following:
93			o What version of crossfire did you use?
94	root	1.2	o What type of computer did you use (CPU type)
95			o What is the version of the OS?
96	pippijn	1.4	o What windowing system are you using (e.g. openwindows, X.org, XFree86)
97			o What compiler (and its version) did you use (e.g. gcc, acc)?
98	root	1.1	o Which flags did you give it?
99	pippijn	1.4	o If the bug happens when compiling crossfire, send an EXACT copy of the
100			compiler line, as well as the errors it puts out. Sending bugs of the
101			sort 'it failed with a line like ...' doesn't help any.
102	root	1.1	o If the bug happened while running crossfire:
103			- Include any output before to the bug.
104			- Give a description of what you did before the bug occured. The better
105	pippijn	1.4	detailed the description, the better chance I have of figuring
106			out where the bug happened, or how I can recreate the bug.
107	root	1.2	- If possible, a stack trace from gdb (or other debugger) is very
108			helpful.
109	root	1.1
110	root	1.2	The more information provided, the better chance of the bug being fixed in
111			a timely fashion.
112	root	1.1
113			------------------------------------------------------------------------------
114	pippijn	1.4	SUBMITTING PATCHES:
115			Patches should be submitted to email address:
116			crossfire@schmorp.de
117	root	1.1
118			PUBLIC SERVERS:
119
120			The best way to find a server to play is to run the client. It will contact
121			the metaserver and present a list to choose from. You can also see
122			a list at http://crossfire.real-time.com/metaserver/
123
124
125			COPYRIGHT
126
127	pippijn	1.4	Copyright (C) 2007 Crossfire Development Team
128			Copyright (C) 2000, 2006 Mark Wedel
129	root	1.1	Copyright (C) 1992 Frank Tore Johansen
130
131			This program is free software; you can redistribute it and/or modify
132			it under the terms of the GNU General Public License as published by
133			the Free Software Foundation; either version 2 of the License, or
134			(at your option) any later version.
135
136			This program is distributed in the hope that it will be useful,
137			but WITHOUT ANY WARRANTY; without even the implied warranty of
138			MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
139			GNU General Public License for more details.
140
141			You should have received a copy of the GNU General Public License
142			along with this program; if not, write to the Free Software
143			Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
144
145	pippijn	1.4	The authors can be reached via e-mail to crossfire@schmorp.de