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

WHAT IS DELIANTRA?

  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 Deliantra client should be used. This client is written
  in Perl and utilises SDL with OpenGL to provide you with the most
  immersive gameplay.

  Deliantra 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 (g++ 4.x works). In addition, you will need the Perl
  development libraries along with the following Perl modules (the server
  is tested with perl 5.8.8, 5.8-maint and 5.10.0. A perl configured for
  64 bit integer support is highly recommended to avoid overflows, but 32
  bit perls are supported) and their dependencies. In general, the newest
  version from CPAN will do. The configure script will complain when it
  detects an unsuitable version.

     - AnyEvent
     - BDB              **compiled against libdb4.[56] (libdb4.4 *might* work)**
     - Compress::LZF
     - Coro             **SEE IMPORTANT NOTICE BELOW**
     - Coro::EV
     - Deliantra
     - Digest::MD5
     - EV
     - IO::AIO
     - JSON::XS
     - Net::IRC3
     - Pod::POM
     - Safe::Hole
     - Storable
     - Time::HiRes
     - URI
     - YAML
     - YAML::Syck

  **NOTICE**: Deliantra uses an alternative signal stack, so you have to
  use either the "u"context method (slow) 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 (possibly higher, depending on its bugs)
     - optipng => v0.5.5 (http://optipng.sf.net)
     - pngnq >= v0.4 (http://freshmeat.net/redir/pngnq/53146/url_homepage/pngnq.html)
     - rsync >= v2.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

  If you want to get sensible backtraces for error conditions at runtime
  to be logged you also need the external addr2line program (part of GNU
  binutils) in your PATH.


COMPILING

  Deliantra 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

  Deliantra 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 build the deliantra server binaries
  and install them, then you will have to download and install map and
  archetype packs:

  Download both the cfmaps-<version> and cfarch-<version> archives, then
  use cfutil to install both (the source directories must be writable for
  this to work):

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

  Both processes can take some time, depending on your resources :) If you
  plan to repeat the installation you should specify the --cache option
  first, which will keep costly-to-generate files around for further runs
  of cfutil:

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

  Atfer this you can then run the deliantra executable. This starts a
  server which you/other people can connect to.


WEB SITES

  The following web addresses have deliantra information that you may find
  useful:

  http://www.deliantra.net/ (The main site)


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:
     support@deliantra.net

  When reporting bugs, make sure you include the following:

  * What version of deliantra did you use?
  * What type of computer did you use (CPU type)
  * What is the version of the OS?
  * What windowing system are you using (e.g. openwindows, X.org, XFree86)
  * What compiler (and its version) did you use (e.g. gcc, acc)?
  * Which flags did you give it?
  * If the bug happens when compiling deliantra, 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.
  * If the bug happened while running deliantra:
    - 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 we have of figuring
      out where the bug happened, or how we 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:
  support@deliantra.net


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

  The canonical server for use with Deliantra and CFPlus is
  gameserver.deliantra.net, port 13327 (the default).


COPYRIGHT

  Most files in this distribution are covered by the GNU General Public
  License, version 3 (COPYING.GPL), or any later version, with the
  exception of ext/affero.ext, which is covered by the GNU Affero General
  Public License, Version 3 (COPYING.Affero). Please take note of the
  special requirements of the Affero license with respect to network
  servers and configure your network server according to the instructions
  given in ext/affero.ext.


CONTACT

  The authors can be reached via e-mail to support@deliantra.net

Revision:	1.43
Committed:	Wed Apr 16 21:14:13 2008 UTC (16 years, 1 month ago) by root
Branch:	MAIN
CVS Tags:	rel-2_6, rel-2_54, rel-2_55, rel-2_56, rel-2_51, rel-2_52, rel-2_53
Changes since 1.42:	+5 -3 lines
Log Message:	* empty log message *
#	User	Rev	Content
1	root	1.30	WHAT IS DELIANTRA?
2	root	1.1
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	root	1.30	experience, the Deliantra client should be used. This client is written
7	root	1.8	in Perl and utilises SDL with OpenGL to provide you with the most
8			immersive gameplay.
9	root	1.1
10	root	1.30	Deliantra 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	root	1.12	compile this game (g++ 4.x works). In addition, you will need the Perl
22			development libraries along with the following Perl modules (the server
23	root	1.43	is tested with perl 5.8.8, 5.8-maint and 5.10.0. A perl configured for
24			64 bit integer support is highly recommended to avoid overflows, but 32
25			bit perls are supported) and their dependencies. In general, the newest
26			version from CPAN will do. The configure script will complain when it
27			detects an unsuitable version.
28	root	1.40
29			- AnyEvent
30	root	1.42	- BDB *compiled against libdb4.[56] (libdb4.4 might* work)**
31	root	1.40	- Compress::LZF
32	root	1.42	- Coro SEE IMPORTANT NOTICE BELOW
33	root	1.40	- Coro::EV
34	root	1.41	- Deliantra
35	root	1.40	- Digest::MD5
36			- EV
37			- IO::AIO
38			- JSON::XS
39			- Net::IRC3
40			- Pod::POM
41			- Safe::Hole
42			- Storable
43			- Time::HiRes
44			- URI
45			- YAML
46			- YAML::Syck
47	pippijn	1.4
48	root	1.30	NOTICE: Deliantra uses an alternative signal stack, so you have to
49	root	1.42	use either the "u"context method (slow) or "a"ssembly when configuring
50			Coro.
51	root	1.11
52	root	1.5	Furthermore, you will need the following programs and libraries:
53	pippijn	1.4
54	root	1.7	- gperf, the GNU perfect hash generator >= v3.0
55	pippijn	1.4	- glib-2.0 >= v2.10
56			- libpng >= v1.2
57	root	1.12	- ImageMagick >= v6.0 (possibly higher, depending on its bugs)
58	root	1.7	- optipng => v0.5.5 (http://optipng.sf.net)
59	root	1.20	- pngnq >= v0.4 (http://freshmeat.net/redir/pngnq/53146/url_homepage/pngnq.html)
60			- rsync >= v2.6 (a must have anyways)
61	pippijn	1.4
62	root	1.5	Your compiler must support the Library Technical Report 1 extensions and
63			the upcoming typeof extension. The GNU C++ compiler >= version 4.0 does
64	root	1.6	support all these.
65	pippijn	1.4
66	root	1.9	On Debian GNU/Linux, you might get away with something like this for many of the
67			above dependencies:
68
69			apt-get install gperf optipng pngnq rsync imagemagick libglib2.0-dev libpng12-dev
70			apt-get install libpod-pom-perl libsafe-hole-perl libevent-perl
71
72	root	1.15	If you want to get sensible backtraces for error conditions at runtime
73	root	1.13	to be logged you also need the external addr2line program (part of GNU
74			binutils) in your PATH.
75
76	root	1.8
77	root	1.1	COMPILING
78
79	root	1.30	Deliantra has been known to compile on a wide variety of systems. It should
80	root	1.8	compile and run on most ISO C++ 200x and POSIX compliant systems.
81
82			To get generic directions on compilation, read the INSTALL file.
83
84	root	1.1
85	root	1.8	INSTALLATION/USAGE
86	root	1.1
87	root	1.30	Deliantra runs on a client/server model. You will also a client to
88	root	1.8	play. You can either connect to a server someone else has set up, or
89			run your own server and connect to that. There are a number of clients
90			available, but the recommended one is CFPlus (see below for URL).
91	root	1.1
92	root	1.30	To run your own server, you need to build the deliantra server binaries
93	root	1.12	and install them, then you will have to download and install map and
94			archetype packs:
95
96			Download both the cfmaps-<version> and cfarch-<version> archives, then
97			use cfutil to install both (the source directories must be writable for
98			this to work):
99	root	1.8
100			cfutil --install-maps path/to/cfmaps-<version>/
101			cfutil --install-arch path/to/cfarch-<version>/
102
103	root	1.12	Both processes can take some time, depending on your resources :) If you
104			plan to repeat the installation you should specify the --cache option
105	root	1.22	first, which will keep costly-to-generate files around for further runs
106			of cfutil:
107
108			cfutil --cache --install-maps path/to/cfmaps-<version>/
109			cfutil --cache --install-arch path/to/cfarch-<version>/
110	root	1.12
111	root	1.30	Atfer this you can then run the deliantra executable. This starts a
112	root	1.12	server which you/other people can connect to.
113	root	1.2
114	root	1.1
115	root	1.18	WEB SITES
116	root	1.1
117	root	1.30	The following web addresses have deliantra information that you may find
118	root	1.1	useful:
119
120	root	1.30	http://www.deliantra.net/ (The main site)
121	root	1.1
122
123			REPORTING BUGS
124
125			First, check the INSTALL file for common problems, and see if yours is
126			mentioned.
127
128	pippijn	1.4	Bugs should be filed using the following email address:
129	root	1.30	support@deliantra.net
130	root	1.1
131			When reporting bugs, make sure you include the following:
132	root	1.12
133	root	1.30	* What version of deliantra did you use?
134	root	1.12	* What type of computer did you use (CPU type)
135			* What is the version of the OS?
136			* What windowing system are you using (e.g. openwindows, X.org, XFree86)
137			* What compiler (and its version) did you use (e.g. gcc, acc)?
138			* Which flags did you give it?
139	root	1.30	* If the bug happens when compiling deliantra, send an EXACT copy of the
140	pippijn	1.4	compiler line, as well as the errors it puts out. Sending bugs of the
141			sort 'it failed with a line like ...' doesn't help any.
142	root	1.30	* If the bug happened while running deliantra:
143	root	1.1	- Include any output before to the bug.
144	root	1.12	- Give a description of what you did before the bug occured. The better
145			detailed the description, the better chance we have of figuring
146			out where the bug happened, or how we can recreate the bug.
147	root	1.2	- If possible, a stack trace from gdb (or other debugger) is very
148			helpful.
149	root	1.1
150	root	1.12	The more information provided, the better chance of the bug being fixed
151			in a timely fashion.
152	root	1.1
153	root	1.18
154			SUBMITTING PATCHES
155	root	1.8
156	root	1.12	Patches should be submitted to email address:
157	root	1.30	support@deliantra.net
158	root	1.18
159	root	1.1
160	root	1.18	PUBLIC SERVERS
161	root	1.1
162	root	1.12	The best way to find a server to play is to run the client
163			and hit "Server List" in the setup dialog (this varies
164	root	1.30	depending on your client).
165	root	1.1
166	root	1.30	The canonical server for use with Deliantra and CFPlus is
167			gameserver.deliantra.net, port 13327 (the default).
168	root	1.1
169	root	1.18
170	root	1.1	COPYRIGHT
171
172	root	1.18	Most files in this distribution are covered by the GNU General Public
173			License, version 3 (COPYING.GPL), or any later version, with the
174			exception of ext/affero.ext, which is covered by the GNU Affero General
175			Public License, Version 3 (COPYING.Affero). Please take note of the
176			special requirements of the Affero license with respect to network
177			servers and configure your network server according to the instructions
178			given in ext/affero.ext.
179
180
181			CONTACT
182	root	1.1
183	root	1.30	The authors can be reached via e-mail to support@deliantra.net
184	root	1.18