Directory Structure
Learn about the file and folder structure required for Plugify, including the `res` directory and configuration files.
Plugify follows a specific directory structure to organize plugins, language modules, and configuration files. Below is an overview of the required folders and files.
Root Directory
The root directory is where you clone the Plugify repository and build the project. It contains the following:
build/
: Contains the compiled binaries and build artifacts.res/
: The main resource directory for plugins and language modules.plugify.pconfig
: The configuration file for theplug
testing app.
Resource Directory
The res
directory is the central location for plugins and language modules. It has the following structure:
plugins/
: Contains individual plugin folders.- Each plugin folder should include:
bin/
: Contains the compiled plugin binaries (e.g.,.dll
,.so
)..pplugin
: The plugin manifest file (e.g.,my-plugin.pplugin
).
- Each plugin folder should include:
modules/
: Contains individual language module folders.- Each language module folder should include:
bin/
: Contains the compiled module binaries (e.g.,.dll
,.so
)..pmodule
: The language module manifest file (e.g.,cpp-module.pmodule
).
- Each language module folder should include:
Example Directory Structure
Here’s an example of how your directory structure might look:
- plugify/
- build/
- plugify.dll
- libplugify.so
- other_binaries
- res/
- plugins/
- my-plugin/
- bin/
- my-plugin.dll
- libmy-plugin.so
- my-plugin.pplugin
- another-plugin/
- bin/
- another-plugin.dll
- libanother-plugin.so
- another-plugin.pplugin
- modules/
- cpp-module/
- bin/
- cpp-module.dll
- libcpp-module.so
- cpp-module.pmodule
- python-module/
- bin/
- python-module.dll
- libpython-module.so
- python-module.pmodule
- plugify.pconfig
Configuration File
The plugify.pconfig
file is required for by any Plugify instance to locate the res
directory and configure its behavior. It should be placed in the root directory and contain the following fields: