Skip to content

Custom Script Template

Erik Bigler edited this page Nov 4, 2018 · 2 revisions

This is a template custom script for Firebot.

exports.getScriptManifest = function() {
	return {
		name: "Script Name",
		description: "This script does something!",
		author: "Your name",
		version: "1.0"
	}
}

exports.getDefaultParameters = function() {
    return new Promise(resolve => {
        resolve({
            someOption: {
                type: "string",
                description: "Option Title",
		secondaryDescription: "Extra Option Info",
                default: ''
            }
        });
    });
}

exports.run = function(runRequest) {
    return new Promise(resolve => {

		// response object
		let response = {
			success: true
		};

		// get parameter
		let option = runRequest.parameters.someOption;
		// do something with it!
		

		// resolve the promise 
		resolve(response);
    });
}
Clone this wiki locally