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

Comparing deliantra/server/README (file contents):
Revision 1.6 by root, Tue Mar 6 22:07:56 2007 UTC vs.
Revision 1.39 by root, Mon Dec 17 06:36:34 2007 UTC

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

Diff Legend

-–
+Removed lines
-+
+Added lines
-<
+Changed lines
->
+Changed lines

Comparing deliantra/server/README (file contents): Revision 1.6 by root, Tue Mar 6 22:07:56 2007 UTC vs. Revision 1.39 by root, Mon Dec 17 06:36:34 2007 UTC

Diff Legend

Comparing deliantra/server/README (file contents):
Revision 1.6 by root, Tue Mar 6 22:07:56 2007 UTC vs.
Revision 1.39 by root, Mon Dec 17 06:36:34 2007 UTC