Skip to content

Naming & Structure

AnkhHeart edited this page Apr 12, 2018 · 4 revisions

Naming Convention

StreamlabsSystem

Files ending with *_StreamlabsSystem.py are System files that contain a Init(), Execute(data) and Tick() function. These are used to extend the core functionality of Streamlabs Chatbot and create your own advanced commands.

StreamlabsParameter

Files ending with *_StreamlabsParameter.py are Parameter files that contains a Parse() function. These are used to create your own $parameters and add to the standard Streamlabs Chatbot Parameter Library.

Placement

StreamlabsSystem & StreamlabsParameter files are to be placed inside of the Streamlabs Chatbot Directory -> Services -> Scripts Folder inside of a Folder named after the Script Itself in order to keep things clean and easily share-able with other users

Distribution

The best way to distribute your Script is to Zip everything up nicely. Here a small example of what a proper Streamlabs Chatbot Script would look like in the form of a .Zip file. The Zip file should contain 1 single folder with the script name:

Fill the folder with your script(s) and dependencies:

Clone this wiki locally