File: README

package info (click to toggle)
koala 0.3.2a-1
  • links: PTS
  • area: main
  • in suites: woody
  • size: 2,036 kB
  • ctags: 582
  • sloc: ansic: 29,449; makefile: 1,666; xml: 11
file content (127 lines) | stat: -rw-r--r-- 5,718 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
@(#) nitehawk@localhost.1ststep.net|README|20000730165942|47296 @(#)
Koala Distributed Mud Server documentation series
Copyright (c) 1999-2000 First Step Internet Services, Inc.
All Rights Reserved

License:
	This software and all the documentation is licensed for usage under
the BSD license.  This licence basically states that you can do whatever you
want with the code, as long as the copyrights remain on the code.  You can
find the full text of this license in the file 'BSD' that came with this
distribution.

Requirements:
	Koala requires libxml, also known as Gnome-xml, for handling the
configuration files.  Koala will no longer compile or run without libxml.

	At this time, Koala requires Glibc 2.1 in order to run on Linux.

	To compile on FreeBSD, gmake is required.  The standard FreeBSD make does
not support some of the structuring that is used for compiling.

IPv6 Information:
	By default, Koala requires a libc that supports the AF independent system
calls.  Most recent systems should have this.  If you are using glibc >= 2.1 or
FreeBSD >= 4.0, you probably have the needed support.  The best thing to do is
to try compiling with the AF independant code enabled.  If it fails, then you
need to specify --disable-afindep to the configure line.  It is better to use
the AF independant code if your system supports it as this line will *always*
be better tested.  This should be autodetected eventually.
	FreeBSD 4.0 now includes IPv6 support.  Curent Koala code is now tested
against this IPv6 support.

Testing:
	Koala has been tested to work on the following configurations:
	Linux-2.3.9 and glibc-2.1.2
	FreeBSD 5.0-Current-20000729

Instalation:
	Nothing really needed here yet.
	To compile:
	*	./configure
	*	Edit include/config.h and make sure all the settings are correct
	*	make
	To Run:
	*	bin/hubd -g koala.xml	// Generate default configuration
	*	bin/hubd				// Start hub daemon
	*	bin/zoned 				// Start zone daemon
	*	bin/clientd				// Start client daemon

	If koala.xml is not changed, this will bring up the hub daemon on port
8204, followed by the zone daemon which will connect to the hub daemon, and
finally the client daemon which will connect to the hub daemon before it
starts listening on port 6464.

	Depending on your system, you may have to tell the system how to find the
shared library.  If hubd fails to start, look at the man pages to find out how
to add a directory to the shared library search path.  libkoala.so is found in
the lib subdirectory.

Compile Notes:
	Please let me know if you get any compile warnings.  If possible, please
include a patch to fix the warnings.

	Koala code builds with optimizations off and debugging symbols on by
default.  If you want optimized binaries, edit Makefile.in and use the other
form of 'MYCFLAGS'.  The cflags that configure comes up with are ignored by
default.

Demonstration Servers:
	The following demonstration servers are available.

	koalamud.org port 6500		This server runs the latest released version
								KoalaMud.
	koalamud.org port 6464		This server runs the absolute latest code
								available.

	I (NiteHawk) am almost always online as Tas, although I'm not always
	around that computer.  If noone responds, just stick around a while and
	someone will probably be around to help/talk to you.

Virtual Memory/Database driver:
	The virtual memory and database driver library is designed to be self
contained and easily split from the main koala code.  This has been done to
make it easy for other projects that may want to use an existing, well tested,
well optimized database and virtual memory driver.  Here are some basic
instructions on what is needed to split off the driver.
	* Copy all the files in lib/vm
	* Copy include/vm.h and include/module.h and include/config.h and
		include/conf.h
	* Copy lib/koala/moduleops.c and lib/koala/conf.c
	These files can all go into the same directory.  The only portion of
config.h that is needed for the driver is the portion that enables/disables
the individual database backends.  Compiling all these files and linking them
in should be sufficient to allow usage of of the vm module in other
applications.
	conf.c depends on include/koalatypes.h for the error return values used.
Other applications may skip using conf.c if they implement similar
functionality.  At a minimum, 'confgetoptionsfromsection' must be
implemented.

Mailing lists:
	There are currently four mailing lists for KoalaMud:
		koalamud@lists.1ststep.net - General discussion list
		koalamud-announce@lists.1ststep.net - Announcement list
		koalamud-devel@lists.1ststep.net - Development list
		koalamud-commit@lists.1ststep.net - Changeset notification list

	All four lists are low volume at this time.  The commit list will likely
be the highest volume list since every changeset commit will trigger a message
sent to the list.  If you are interested in contributing code to koalamud, it
is highly recommended that you join all four lists.  Any official developer
is required to be on all koalamud lists.

	To subscribe to a list, send a message to:
		listname-subscribe@lists.1ststep.net

	The contents of the subject header and body of the message are ignored.

Contributing:
	The easiest way for me to make use of contributions is if they are provided
as BitKeeper (www.bitkeeper.com) changesets.   The distribution is actually a
BitKeeper repository.  I'm not going to go into the operation of bitkeeper here,
but if you would like help on doing things correctly, don't hesitate to ask.
Use 'bk send' to send your changesets to: submit@koalamud.org

If you do not have access to BitKeeper, please send unified diffs with a good
description of the changes to: submit@koalamud.org