Creating a plugin

Layout

plugins/my-plugin/
  plugin.json
  src/MyPluginServiceProvider.php
  routes/admin.php
  routes/public.php   # optional
  views/
  migrations/
  composer.json       # optional third-party deps

Slug rules

Directory name must match plugin.json → slug: lowercase letters, numbers, hyphens only (^[a-z0-9]+(?:-[a-z0-9]+)*$).

Minimal plugin.json

{
  "name": "My Plugin",
  "slug": "my-plugin",
  "version": "1.0.0",
  "author": "Example Co",
  "main_class": "MyPlugin\\MyPluginServiceProvider"
}

Service provider

<?php
namespace MyPlugin;

use App\Plugin\PluginBootContext;
use App\Plugin\PluginServiceProviderInterface;

final class MyPluginServiceProvider implements PluginServiceProviderInterface
{
    public function boot(PluginBootContext $context): void
    {
        $context->registerAdminNavItem('My plugin', 'plugin.my_plugin.admin');
    }
}

Activate

1. Copy plugin into plugins/my-plugin/ or install from catalog.
2. Run composer plugin-deps:prod if the plugin has composer.json.
3. Go to Extensions → Plugins.
4. Review compatibility report.
5. Click Activate — migrations run, boot() executes.

Catalog install

Extensions → Plugins → Browse catalog installs from struxapoint.com/struxa-dist/repo.json (or STRUXA_DIST_CATALOG_URL). After install, activate separately.

Troubleshooting

• Activation blocked — Read compatibility report: PHP version, CMS version, missing dependencies, conflicts.
• Class not found — Check main_class and PSR-4 autoload in plugin.json.