Creating Your Own Addon Modules

To create your own Spout addon modules, simply create a new folder in the /spout/addons/ directory. Follow the module standards in modules and create your own custom functions and spoutlet templates. If you want you can use one or more spoutlets from the core modules and their handlers instead of creating your own spoutlet templates.

Downloading Addon Modules

Simply find a repository that has the addon you need and copy the folder into the /spout/addons/ directory with git or other methods to clone the repository.

Installing Addon Modules

to make sure addons are imported into the main AHK script, either run the spout/shared/IncludesGenerator.ahk script or run the QuickStart.ahk script.

Example: Installing the Prompt_Booster Demo

To install the prompt_booster example addon, which enhances text prompts to make them more comprehensive and effective, follow these steps:

  1. Create the addon directory:
    cd spout_workspace/spout/addons
    mkdir prompt_booster
    
  2. Clone the prompt_booster repository:
    cd prompt_booster
    git clone https://github.com/skjp/prompt_booster.git .
    
  3. Register the addon by running the IncludeGenerator.ahk' script or QuickStart.ahk` script:
    cd ../..
    ./shared/IncludesGenerator.ahk
    
  4. the prompt_booster's functionality should now be available hokey example console shortcut: capslock + F1 or by running the following command in the terminal:
     spout prompt_booster "I need an SVG of a cat"
    

Challenge yourself to create a custom addon:

  • Website scraper
  • Bulk file namer
  • SVG generator
  • React component generator
  • Dashboard for analyzing API logs