Plug-ins (.nplugin)
Overview
The .nplugin file represents the configuration of a plug-in for the engine. It specifies the name of the plug-in, GUID and more. Plug-ins can be stored anywhere on disk.
Plug-in Config Metadata
-
version
This plug-in version number in the format of
. . . -
name
This plug-in's human readable name
-
guid
This plug-in's unique identifier.
-
asset_directory
The directory in which the plug-in's assets are stored.
-
source_directory
The directory in which the plug-in's source code is contained.
-
binary_directory
The directory in which the plug-in's binaries are output.
-
library_directory
The directory in which the plug-in's libraries are output.
-
plugin_dependencies
An array containing the unique identifiers of plug-ins that this plug-in depends on. Plug-ins referenced here will be automatically loaded when this plug-in is loaded.
Available Shell Menu Actions
-
Generate Solution
Generates a C++ solution used to build the plug-in
-
Associate with Current Engine
Registers the plug-in in the current engine's plug-in database
Before being used with a project, the plug-in must be associated with the engine version used by that project.
Engine Database
The engine plug-in database is a per-engine JSON file containing relative or absolute file paths to plug-ins supported by the engine.
Feedback
Please be sure to submit issues or feature requests through the embedded feedback form. In the event it is a major issue please contact us directly through Discord.
