Plugins

Plugins are a way to extend the functionality of the Engine. They allow you to add new features to the Engine without having to modify the core code.

Creating a Plugin

There is two ways to create a new plugin:

1. Use the bshg plugins generate command to create a new plugin and generate the necessary files.
2. Use the GitHub template to create a new plugin repository: bshengine.plugin.template 

Plugin Structure

The BSH Engine plugin system uses three essential file types that work together to define and install plugin components:

1. Config file - bshplugin.json: should be placed in the root of the plugin directory. it defines the plugin identity, metadata, and variables.
2. Manifest files - __manifest__.json: located inside each component directory (e.g., BshTypes/, BshSchemas/, etc.). it defines the metadata, dependencies, and loading order of the content files.
3. Content files - dir/**/*.json: located anywhere within component directories (supports nested structure). it contains the actual data/definitions that get installed into target entities.

• my-plugin
  • bshplugin.json
  • BshEntities
    • __manifest__.json
    • user.json
    • country.json
  • BshTypes
    • __manifest__.json
    • CountryCode.json
    • Email.json
  • BshSchemas
    • __manifest__.json
    • UserSchema.json
    • CountrySchema.json

Plugin Installation