View on GitHub

LynxBot

A Twitch.tv IRC bot for Old School Runescape

Download this project as a .zip file Download this project as a tar.gz file

wheel.json(4) - LynxBot manual

DESCRIPTION

wheel.json is the file which contains the implementation of the selection wheel.

SYNOPSIS

The format of wheel.json is as follows:

{
    "wheelactive": true,
    "wheelname": "Selection Wheel",
    "wheelcmd": "swheel",
    "wheeldesc": "Selects items at random from various categories.",
    "wheelusage": "Use \"$swheel\" followed by the name of a category, or \"$swheel check\".",
    "wheelcooldown": 20,
    "categories": {
        "letter": [
            "a",
            "b",
            "c"
        ],
        "number": [
            "1",
            "2",
            "3"
        ]
    }
}
wheelactive

Whether the Selection Wheel is active.

wheelname

The full name of the wheel.

wheelcmd

The command keyword to use the wheel.

wheeldesc

The description of the wheel.

wheelusage

A message describing how to use the wheel (typically containing the names of each available category).

wheelcooldown

The cooldown of the wheel.

categories

An object which contains arrays of strings.

Each array represents a wheel category and each string in the array is an item within that category.

The name of each array is what the user would specify in the wheel command.

SEE ALSO

Selection Wheel(3)