README
SockBot Markov
Markov plugin for SockBot version 2.10.0 or later; generates semi-coherent posts using a Markov chain generator.
Usage
No special syntax is required; simply summon, reply, or send a private message.
Developers
SockBot Markov is developed by SockDrawer developer RaceProUK.
Installation
The preferred method of installation is via NPM; simply run this command within the SockBot installation folder:
npm install sockbot-markov
Other methods of installation are possible e.g. cloning the git repository, but only installation via NPM is supported.
Post Install Setup
If you installed via NPM skip this step as NPM has already installed all necessary dependencies. Otherwise you will need to run the following command in the folder where you installed SockBot Markov:
npm install
Configuration
SockBot Markov requires a text file to generate the corpus that powers the Markov chain; this is specified by the corpus
setting.
YAML example:
---
core:
username: username
password: password
owner: owner
plugins:
sockbot-markov:
corpus: '../path/to/corpus.txt'
JSON example:
{
"core": {
"username": "username",
"password": "password",
"owner": "owner"
},
"plugins": {
"sockbot-markov": {
"corpus": "../path/to/corpus.txt"
}
}
}
Note that these examples assume an NPM-based installation; other installation methods may require the path to Markov.js
(without file extension) be specified explicitly.
YAML example:
---
core:
username: username
password: password
owner: owner
plugins:
'../path/to/Markov':
corpus: '../path/to/corpus.txt'
JSON example:
{
"core": {
"username": "username",
"password": "password",
"owner": "owner"
},
"plugins": {
"../path/to/Markov": {
"corpus": "../path/to/corpus.txt"
}
}
}
Special Thanks
For creating SockBot and just generally being awesome: Accalia de Elementia