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 the plug 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).
  • 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).

Example Directory Structure

Here’s an example of how your directory structure might look:

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:

plugify.pconfig
{
    "$schema": "https://raw.githubusercontent.com/untrustedmodders/plugify/refs/heads/main/schemas/config.schema.json",
    "baseDir": "res",
    "logSeverity": "debug",
    "repositories": [],
    "preferOwnSymbols": false
}