Skip to content

shrimpza/zomb

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

119 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ZOMB

Build Status

ZOMB provides an API-driven HTTP back-end for an IRC bot style command processor, where functionality is implemented in remotely-hosted HTTP based plugin services.

Clients

To actually "use" ZOMB, a client application is required:

  • zomb-web - a browser-based client
  • zomb-cli - a command-line client suitable for use from a terminal

API documentation

Client Usage

The following are commands issued by a user via a ZOMB client (see zomb-web as an example). The same interactions may be achieved programmatically via the Client API.

General Usage

Instructions are given in the following format:

<plugin-name> <command> [arguments]

  • <plugin-name>
    name of an installed plugin
  • <command>
    a command which exists within the plugin specified
  • [arguments]
    many commands require additional arguments, which may be passed to the command as a space-separated list. multi-word arguments may be surrounded by double or single quotes

Plugin Management

In order for ZOMB to be useful, plugins must be added. Plugins implement the actual functionality ZOMB provides.

Plugin management is achieved using the same language and request style as normal usage.

Add a plugin:

plugin add http://url.to/plugin/script

Remove a plugin:

plugin remove plugin-name

Help And Information

List available (installed) plugins:

plugin list

Plugin information:

help show plugin-name

List plugin commands:

help list plugin-name

Plugin command help:

help show plugin-name command-name

About

Plugin-based bot-style backend.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages