Structure

Plugin Structure¶

Plugins are packaged as Python modules and distributed as .zip archives.

1
2
3
4
5
6
7

plugin.zip/
└── plugin/
    ├── __init__.py  # Entry point
    ├── plugin.py
    └── util/
        ├── discovery.py
        └── ...

The __init__.py file serves as the plugin's entry point.

Available Templates¶

Ocelescope provides ready-to-use templates to simplify development:

Minimal Plugin Template (GitHub)¶

A minimal example plugin is available on GitHub:

1
2

git clone https://github.com/Grkmr/minimal-plugin.git
cd minimal-plugin

For detailed setup instructions, refer to the Setup section of the tutorial.