Skip to content

Sawmon Plugin API

Bart Langelaan edited this page Nov 4, 2016 · 1 revision

Every plugin must export a object, that can implement the following properties:

module.exports.dependencies = array

module.exports.servers = {}
module.exports.servers.refresh = function(passTrough) -> Promise
module.exports.servers.ping = function(passTrough) -> Promise
module.exports.servers.fields[] = {String name, String key, String type, String placeholder, Bool secret}
module.exports.servers.display[] = {String name, Function value(server) -> String}

module.exports.websites = {} // accepts the same properties as module.exports.servers
Clone this wiki locally