Help Center

plugin.php file is the core metadata descriptor for any addon in the ScriptsTribe Plugin System. It is always located inside /modules/{addonid}/plugin.php and is automatically read by the system loader.

Structure & Keys

Typically, plugin.php returns an associative array with information about the addon:

 'myaddon', // Unique ID = folder name
  'label'         => 'My Addon', // Human-readable name
  'description'   => 'Adds custom features to your Sngine site.',
  'author'        => 'ScriptsTribe',
  'author_url'    => 'https://scriptstribe.com',
  'version'       => '1.0.0',
  'screenshot'    => '/modules/myaddon/assets/img/preview.png',
  'installed'     => false,   // System will update this after install
  'active'        => false,   // True when addon is activated
  'support_url'   => 'https://scriptstribe.com/helpcenter',
  'requires_verification' => false, // If addon needs license check
  'sngine_version' => '>=4.0.0', // Minimum required Sngine version
];

• id – must match the folder name under /modules/.
• label – friendly name shown in admin panel.
• description – short text shown in addon list.
• author / author_url – credits and link.
• version – addon version (follows semantic versioning).
• screenshot – preview image path (used in admin).
• installed / active – flags set by system, not user.
• support_url – help link for customers.
• requires_verification – true if license key required.
• sngine_version – ensures compatibility.

Demo Addon Example

Below is a working demo addon using plugin.php:

📂 modules
└── 📂 hello_world
    ├── plugin.php
    ├── index.php
    ├── init.php
    └── assets
        └── img
            └── preview.png

plugin.php:

 'hello_world',
  'label'         => 'Hello World Addon',
  'description'   => 'A demo addon that prints Hello World on the home page.',
  'author'        => 'Jane / ScriptsTribe',
  'author_url'    => 'https://scriptstribe.com',
  'version'       => '1.0.0',
  'screenshot'    => '/modules/hello_world/assets/img/preview.png',
  'installed'     => false,
  'active'        => false,
  'support_url'   => 'https://scriptstribe.com/helpcenter',
  'requires_verification' => false,
  'sngine_version' => '>=4.0.0'
];

init.php:

assign('hello_world_message', 'Hello World from my addon!');

index.tpl (in theme):

Usage

1. Upload addon under /modules/hello_world/.
2. Go to Admin Panel → Plugins.
3. Click Install → then Activate.
4. The message Hello World from my addon! will appear on the home page.

✔️ That’s the minimal working demo showing how plugin.php identifies the addon and how it plugs into the system.