[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
  requires perl 5.10.1). 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.

     - common::sense
     - AnyEvent
     - AnyEvent::AIO
     - AnyEvent::BDB
     - BDB              **compiled against libdb4.[567] (libdb4.4 *might* work)**
     - Compress::LZF
     - Coro             **SEE IMPORTANT NOTICE BELOW**
     - Coro::EV
     - Deliantra
     - Digest::MD5
     - EV
     - Guard
     - IO::AIO
     - JSON::XS
     - AnyEvent::IRC
     - Pod::POM
     - Safe::Hole
     - Storable
     - URI
     - YAML::XS

  **NOTICE**: Deliantra uses an alternative signal stack, so you cannot
  use the sigaltstack method (== setjmp on unrecognised platforms) for
  Coro. Try "a"ssembly, "u"context or "p"threads as backend instead on
  those platforms.

  Furthermore, you will need the following programs and libraries:

     - gperf, the GNU perfect hash generator >= v3.0
     - blitz++ >= 0.10
     - glib-2.0 >= v2.32
     - libpng >= v1.2
     - ImageMagick >= v6.6.9 (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 libblitz0-dev

  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 need 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, the recommended one is the Deliantra Client (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.60
Committed:	Thu Nov 17 23:28:04 2016 UTC (7 years, 5 months ago) by root
Branch:	MAIN
Changes since 1.59:	+1 -1 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.50	requires perl 5.10.1). A perl configured for 64 bit integer support is
24	root	1.45	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.
28	root	1.40
29	root	1.49	- common::sense
30	root	1.40	- AnyEvent
31	root	1.44	- AnyEvent::AIO
32			- AnyEvent::BDB
33	root	1.45	- BDB *compiled against libdb4.[567] (libdb4.4 might* work)**
34	root	1.40	- Compress::LZF
35	root	1.42	- Coro SEE IMPORTANT NOTICE BELOW
36	root	1.40	- Coro::EV
37	root	1.41	- Deliantra
38	root	1.40	- Digest::MD5
39			- EV
40	root	1.47	- Guard
41	root	1.40	- IO::AIO
42			- JSON::XS
43	elmex	1.46	- AnyEvent::IRC
44	root	1.40	- Pod::POM
45			- Safe::Hole
46			- Storable
47			- URI
48	root	1.48	- YAML::XS
49	pippijn	1.4
50	root	1.52	NOTICE: Deliantra uses an alternative signal stack, so you cannot
51			use the sigaltstack method (== setjmp on unrecognised platforms) for
52			Coro. Try "a"ssembly, "u"context or "p"threads as backend instead on
53			those platforms.
54	root	1.11
55	root	1.5	Furthermore, you will need the following programs and libraries:
56	pippijn	1.4
57	root	1.7	- gperf, the GNU perfect hash generator >= v3.0
58	root	1.59	- blitz++ >= 0.10
59	root	1.60	- glib-2.0 >= v2.32
60	pippijn	1.4	- libpng >= v1.2
61	root	1.57	- ImageMagick >= v6.6.9 (possibly higher, depending on its bugs)
62	root	1.7	- optipng => v0.5.5 (http://optipng.sf.net)
63	root	1.20	- pngnq >= v0.4 (http://freshmeat.net/redir/pngnq/53146/url_homepage/pngnq.html)
64			- rsync >= v2.6 (a must have anyways)
65	pippijn	1.4
66	root	1.5	Your compiler must support the Library Technical Report 1 extensions and
67			the upcoming typeof extension. The GNU C++ compiler >= version 4.0 does
68	root	1.6	support all these.
69	pippijn	1.4
70	root	1.9	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	root	1.54	apt-get install libpod-pom-perl libsafe-hole-perl libevent-perl libblitz0-dev
75	root	1.9
76	root	1.15	If you want to get sensible backtraces for error conditions at runtime
77	root	1.13	to be logged you also need the external addr2line program (part of GNU
78			binutils) in your PATH.
79
80	root	1.8
81	root	1.1	COMPILING
82
83	root	1.30	Deliantra has been known to compile on a wide variety of systems. It should
84	root	1.8	compile and run on most ISO C++ 200x and POSIX compliant systems.
85
86			To get generic directions on compilation, read the INSTALL file.
87
88	root	1.1
89	root	1.8	INSTALLATION/USAGE
90	root	1.1
91	root	1.51	Deliantra runs on a client/server model. You will also need a client to
92	root	1.8	play. You can either connect to a server someone else has set up, or
93			run your own server and connect to that. There are a number of clients
94	root	1.51	available, the recommended one is the Deliantra Client (see below for URL).
95	root	1.1
96	root	1.30	To run your own server, you need to build the deliantra server binaries
97	root	1.12	and install them, then you will have to download and install map and
98			archetype packs:
99
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):
103	root	1.8
104			cfutil --install-maps path/to/cfmaps-<version>/
105			cfutil --install-arch path/to/cfarch-<version>/
106
107	root	1.12	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	root	1.22	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	root	1.12
115	root	1.30	Atfer this you can then run the deliantra executable. This starts a
116	root	1.12	server which you/other people can connect to.
117	root	1.2
118	root	1.1
119	root	1.18	WEB SITES
120	root	1.1
121	root	1.30	The following web addresses have deliantra information that you may find
122	root	1.1	useful:
123
124	root	1.30	http://www.deliantra.net/ (The main site)
125	root	1.1
126
127			REPORTING BUGS
128
129			First, check the INSTALL file for common problems, and see if yours is
130			mentioned.
131
132	pippijn	1.4	Bugs should be filed using the following email address:
133	root	1.30	support@deliantra.net
134	root	1.1
135			When reporting bugs, make sure you include the following:
136	root	1.12
137	root	1.30	* What version of deliantra did you use?
138	root	1.12	* What type of computer did you use (CPU type)
139			* What is the version of the OS?
140			* What windowing system are you using (e.g. openwindows, X.org, XFree86)
141			* What compiler (and its version) did you use (e.g. gcc, acc)?
142			* Which flags did you give it?
143	root	1.30	* If the bug happens when compiling deliantra, send an EXACT copy of the
144	pippijn	1.4	compiler line, as well as the errors it puts out. Sending bugs of the
145			sort 'it failed with a line like ...' doesn't help any.
146	root	1.30	* If the bug happened while running deliantra:
147	root	1.1	- Include any output before to the bug.
148	root	1.12	- Give a description of what you did before the bug occured. The better
149			detailed the description, the better chance we have of figuring
150			out where the bug happened, or how we can recreate the bug.
151	root	1.2	- If possible, a stack trace from gdb (or other debugger) is very
152			helpful.
153	root	1.1
154	root	1.12	The more information provided, the better chance of the bug being fixed
155			in a timely fashion.
156	root	1.1
157	root	1.18
158			SUBMITTING PATCHES
159	root	1.8
160	root	1.12	Patches should be submitted to email address:
161	root	1.30	support@deliantra.net
162	root	1.18
163	root	1.1
164	root	1.18	PUBLIC SERVERS
165	root	1.1
166	root	1.12	The best way to find a server to play is to run the client
167			and hit "Server List" in the setup dialog (this varies
168	root	1.30	depending on your client).
169	root	1.1
170	root	1.30	The canonical server for use with Deliantra and CFPlus is
171			gameserver.deliantra.net, port 13327 (the default).
172	root	1.1
173	root	1.18
174	root	1.1	COPYRIGHT
175
176	root	1.18	Most files in this distribution are covered by the GNU General Public
177			License, version 3 (COPYING.GPL), or any later version, with the
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.
183
184
185			CONTACT
186	root	1.1
187	root	1.30	The authors can be reached via e-mail to support@deliantra.net
188	root	1.18