README.md


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

## What is JabberHive?
JabberHive is a modular Reply Bot system. All "modules" are in fact separate
programs linked together using the JabberHive Protocol. Please refer to the
protocol for more information.

## Component Description
* Server for a JabberHive network.
* Handles learning & replying using K-order Markov Chains, with k >= 2.
* Knowledge is kept in RAM.

## JabberHive Protocol Compatibility
* **Protocol Version(s):** 1 (Targeted).
* **Inbound Connections:** Multiple.
* **Outbound Connections:** None.
* **Pipelining:** No.
* **Behavior:** Server.

## Dependencies
- POSIX compliant OS.
- C compiler (with C99 support).
- (GNU) make.

## How to Build
* Download the source code.
* Enter the following command: ``$ make``.
* Run ``$ ./jh-markov-k-ram`` to see how to use the binary.

## Example of Use
* Create a server instance with a socket named ``/tmp/jh0`` and markov order of
   3: ``$ ./jabberhive-markov-k-ram /tmp/jh0 3``