Setup Options

Superscript Setup options

  superscript.setup(options,callback);

@param {Object} options

• Any configuration settings you want to use.

@param {String} options.mongoURI

• The database URL you want to connect to. This will be used for both the chat and fact system.

@param {String} options.importFile

• Use this if you want to re-import your parsed '.json' file. Otherwise SuperScript will use whatever it currently finds in the database.

@param {Object} options.factSystem

• Settings to use for the fact system.

@param {Boolean} options.factSystem.clean

• If you want to remove everything in the fact system upon launch. Otherwise SuperScript will keep facts from the last time it was run.

@param {Array} options.factSystem.importFiles

• Any additional data you want to import into the fact system.

@param {Object} options.scope

• Any extra scope you want to pass into your plugins.

@param {Boolean} options.editMode

• Used in the editor.

@param {String} options.pluginsPath

• A path to the plugins written by you. This loads the entire directory recursively.

@param {String} options.logPath

• If null, logging will be off. Otherwise writes conversation transcripts to the path.

@param {Boolean} options.useMultitenancy

• If true, will return a bot instance instead of a bot, so you can get different tenancies of a single server. Otherwise, returns a default bot in the 'master' tenancy.

@param {Number} options.conversationTimeout

• The time to wait before a conversation expires, so you start matching from the top-level triggers.