Skip to content

Modules

lord-willard edited this page Jul 27, 2024 · 3 revisions

A module represent a package of scripts which provides the user with various but related functionalities.

Create Module

To add custom module, run Igor in administrative mode and navigate to Create Module and follow the prompts. Have the following information ready:

  • A descriptive name of module the to display to the user

  • Unique name to identify the module from the list of modules.  It will be used as the name of the directory which will contain the module content.

  • The absolute path of the working directory which will be used to develop the new module, usually a git workspace.

Igor will create a file named config.json in the provided workspace and register the module within Igor's environment as experimental. Each time Igor is invoked, it will detect the module is experimental and will sync with the provide workspace.

For more detail on the structure and syntax used within config.json, see chapter ???

Install Module

To add an available module, run Igor in administrative mode and navigate to Install Module and follow the prompts. Have the following information ready:

  • Absolute path to one of the following

    • directory contaning the module contents

    • directory housng one or more modules

    • zip file containting one ore more modules

Igor will validate the module and if valid, register the module within Igor's environment.

Remove Module

Removal of a module is achieved, by running Igor in administrative mode and navigate to Remove Module and follow the prompts.

Clone this wiki locally