[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.52 by root, Fri Apr 22 02:03:10 2011 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	requires perl 5.10.1). A perl configured for 64 bit integer support is
		24	highly recommended to avoid overflows, but 32 bit perls are supported)
		25	and their dependencies. In general, the newest version from CPAN will
		26	do. The configure script will complain when it detects an unsuitable
		27	version.
22		28
23	- Crossfire >= v0.97	29	- common::sense
24	- Coro >= v3.5	30	- AnyEvent
25	- Coro::Event >= v2.1	31	- AnyEvent::AIO
26	- Event >= v1.08	32	- AnyEvent::BDB
27	- IO::AIO >= 2.32	33	- BDB *compiled against libdb4.[567] (libdb4.4 might* work)**
28	- BDB >= v0.1	34	- Compress::LZF
29	- Storable >= v2.0	35	- Coro SEE IMPORTANT NOTICE BELOW
30	- Time::HiRes >= v1.0	36	- Coro::EV
31	- YAML::Syck >= v0.71	37	- Deliantra
32	- Digest::MD5 >= v2.0	38	- Digest::MD5
33	- Compress::LZF >= v1.71	39	- EV
		40	- Guard
		41	- IO::AIO
		42	- JSON::XS
		43	- AnyEvent::IRC
		44	- Pod::POM
34	- Safe::Hole >= v0.10	45	- Safe::Hole
35	- Pod::POM >= v0.17	46	- Storable
		47	- Time::HiRes
		48	- URI
		49	- YAML::XS
		50
		51	NOTICE: Deliantra uses an alternative signal stack, so you cannot
		52	use the sigaltstack method (== setjmp on unrecognised platforms) for
		53	Coro. Try "a"ssembly, "u"context or "p"threads as backend instead on
		54	those platforms.
36		55
37	Furthermore, you will need the following programs and libraries:	56	Furthermore, you will need the following programs and libraries:
38		57
39	- gperf, the GNU perfect hash generator	58	- gperf, the GNU perfect hash generator >= v3.0
40	- glib-2.0 >= v2.10	59	- glib-2.0 >= v2.10
41	- libpng >= v1.2	60	- libpng >= v1.2
42	- ImageMagick >= 6.0 (convert must be in your PATH).	61	- ImageMagick >= v6.0 (possibly higher, depending on its bugs)
43	- optipng (http://optipng.sf.net)	62	- optipng => v0.5.5 (http://optipng.sf.net)
		63	- pngnq >= v0.4 (http://freshmeat.net/redir/pngnq/53146/url_homepage/pngnq.html)
		64	- rsync >= v2.6 (a must have anyways)
44		65
45	Your compiler must support the Library Technical Report 1 extensions and	66	Your compiler must support the Library Technical Report 1 extensions and
46	the upcoming typeof extension. The GNU C++ compiler >= version 4.0 does	67	the upcoming typeof extension. The GNU C++ compiler >= version 4.0 does
47	support all these.	68	support all these.
48		69
		70	On Debian GNU/Linux, you might get away with something like this for many of the
		71	above dependencies:
		72
		73	apt-get install gperf optipng pngnq rsync imagemagick libglib2.0-dev libpng12-dev
		74	apt-get install libpod-pom-perl libsafe-hole-perl libevent-perl
		75
		76	If you want to get sensible backtraces for error conditions at runtime
		77	to be logged you also need the external addr2line program (part of GNU
		78	binutils) in your PATH.
		79
		80
49	COMPILING	81	COMPILING
50		82
51	Crossfire has been known to compile on a wide variety of systems. It should	83	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.	84	compile and run on most ISO C++ 200x and POSIX compliant systems.
53		85
54	To get directions on compilation for UNIX/LINUX, read the INSTALL file.	86	To get generic directions on compilation, read the INSTALL file.
55		87
56	USAGE
57		88
58	Crossfire runs on a client/server model. You will also need the client	89	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		90
63	To run your own server, you need to make the crossfire binaries	91	Deliantra runs on a client/server model. You will also need a client to
64	and install them, and then run the crossfire program. This now	92	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	93	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	94	available, the recommended one is the Deliantra Client (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		95
72	If you plan to run a long term server, you should use one of the scripts	96	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.	97	and install them, then you will have to download and install map and
		98	archetype packs:
74		99
75	WEB SITES:	100	Download both the cfmaps-<version> and cfarch-<version> archives, then
		101	use cfutil to install both (the source directories must be writable for
		102	this to work):
76		103
		104	cfutil --install-maps path/to/cfmaps-<version>/
		105	cfutil --install-arch path/to/cfarch-<version>/
		106
		107	Both processes can take some time, depending on your resources :) If you
		108	plan to repeat the installation you should specify the --cache option
		109	first, which will keep costly-to-generate files around for further runs
		110	of cfutil:
		111
		112	cfutil --cache --install-maps path/to/cfmaps-<version>/
		113	cfutil --cache --install-arch path/to/cfarch-<version>/
		114
		115	Atfer this you can then run the deliantra executable. This starts a
		116	server which you/other people can connect to.
		117
		118
		119	WEB SITES
		120
77	The following web addresses have crossfire information that you may find	121	The following web addresses have deliantra information that you may find
78	useful:	122	useful:
79		123
80	http://crossfire.schmorp.de/ (The main site)	124	http://www.deliantra.net/ (The main site)
81
82	http://crossfire.real-time.com/ (The website for the old Crossfire game)
83		125
84		126
85	REPORTING BUGS	127	REPORTING BUGS
86		128
87	First, check the INSTALL file for common problems, and see if yours is	129	First, check the INSTALL file for common problems, and see if yours is
88	mentioned.	130	mentioned.
89		131
90	Bugs should be filed using the following email address:	132	Bugs should be filed using the following email address:
91	crossfire@schmorp.de	133	support@deliantra.net
92		134
93	When reporting bugs, make sure you include the following:	135	When reporting bugs, make sure you include the following:
		136
94	o What version of crossfire did you use?	137	* What version of deliantra did you use?
95	o What type of computer did you use (CPU type)	138	* What type of computer did you use (CPU type)
96	o What is the version of the OS?	139	* What is the version of the OS?
97	o What windowing system are you using (e.g. openwindows, X.org, XFree86)	140	* 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)?	141	* What compiler (and its version) did you use (e.g. gcc, acc)?
99	o Which flags did you give it?	142	* Which flags did you give it?
100	o If the bug happens when compiling crossfire, send an EXACT copy of the	143	* 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	144	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.	145	sort 'it failed with a line like ...' doesn't help any.
103	o If the bug happened while running crossfire:	146	* If the bug happened while running deliantra:
104	- Include any output before to the bug.	147	- Include any output before to the bug.
105	- Give a description of what you did before the bug occured. The better	148	- Give a description of what you did before the bug occured. The better
106	detailed the description, the better chance I have of figuring	149	detailed the description, the better chance we have of figuring
107	out where the bug happened, or how I can recreate the bug.	150	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	151	- If possible, a stack trace from gdb (or other debugger) is very
109	helpful.	152	helpful.
110		153
111	The more information provided, the better chance of the bug being fixed in	154	The more information provided, the better chance of the bug being fixed
112	a timely fashion.	155	in a timely fashion.
113		156
114	------------------------------------------------------------------------------
115	SUBMITTING PATCHES:
116	Patches should be submitted to email address:
117	crossfire@schmorp.de
118		157
119	PUBLIC SERVERS:	158	SUBMITTING PATCHES
120		159
		160	Patches should be submitted to email address:
		161	support@deliantra.net
		162
		163
		164	PUBLIC SERVERS
		165
121	The best way to find a server to play is to run the client. It will contact	166	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	167	and hit "Server List" in the setup dialog (this varies
123	a list at http://crossfire.real-time.com/metaserver/	168	depending on your client).
		169
		170	The canonical server for use with Deliantra and CFPlus is
		171	gameserver.deliantra.net, port 13327 (the default).
124		172
125		173
126	COPYRIGHT	174	COPYRIGHT
127		175
128	Copyright (C) 2007 Crossfire Development Team	176	Most files in this distribution are covered by the GNU General Public
129	Copyright (C) 2000, 2006 Mark Wedel	177	License, version 3 (COPYING.GPL), or any later version, with the
130	Copyright (C) 1992 Frank Tore Johansen	178	exception of ext/affero.ext, which is covered by the GNU Affero General
		179	Public License, Version 3 (COPYING.Affero). Please take note of the
		180	special requirements of the Affero license with respect to network
		181	servers and configure your network server according to the instructions
		182	given in ext/affero.ext.
131		183
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		184
137	This program is distributed in the hope that it will be useful,	185	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		186
142	You should have received a copy of the GNU General Public License	187	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		188
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.52 by root, Fri Apr 22 02:03:10 2011 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.52 by root, Fri Apr 22 02:03:10 2011 UTC