uplugin

Uplugin related commands

Usage:

uplugin [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
--help	boolean	Show this message and exit.	Sentinel.UNSET

uplugin build

Build and package one or more uplugins for distribution.

Usage:

uplugin build [OPTIONS]

Options:

Name	Type	Description	Default
--config-file	file	Path to the settings JSON file	Sentinel.UNSET
--uplugin-paths	file	A path to a uplugin to build. Can be specified multiple times.	Sentinel.UNSET
--uplugin-names	text	A name of a plugin, to build, will be checked for in uproject, then engine install. Can be specified multiple times.	Sentinel.UNSET
--output-directory	directory	Path to the output directory	Sentinel.UNSET
--target-platforms	text	A target platform to target, can be specified multiple times (e.g. Win64).	['Win64']
--no-host-platform	boolean	Prevent compiling for the editor platform on the host	False
--strict-includes	boolean	Disables precompiled headers and unity build in order to check all source files have self-contained headers.	False
--unversioned	boolean	Do not embed the current engine version into the descriptor	False
--zip	boolean	Zips the compiled uplugin(s) into the output directory	False
--help	boolean	Show this message and exit.	Sentinel.UNSET

uplugin generate

Generates a uplugin in a directory, within the specified directory with the given settings.

Usage:

uplugin generate [OPTIONS] PLUGINS_DIRECTORY PLUGIN_NAME

Options:

Name	Type	Description	Default
--can-contain-content	boolean	Whether the plugin can contain content.	True
--is-installed	boolean	Whether the plugin is installed.	True
--is-hidden	boolean	Whether the plugin is hidden.	False
--no-code	boolean	Whether the plugin should contain code.	False
--category	text	Category for the plugin.	Modding
--created-by	text	Name of the creator of the plugin.	``
--created-by-url	text	URL of the creator of the plugin.	``
--description	text	Description of the plugin.	``
--docs-url	text	Documentation URL for the plugin.	``
--editor-custom-virtual-path	text	Custom virtual path for the editor.	``
--enabled-by-default	text	Whether the plugin is enabled by default.	True
--engine-major-version	integer	Major Unreal Engine version for the plugin.	4
--engine-minor-version	integer	Minor Unreal Engine version for the plugin.	27
--support-url	text	Support URL for the plugin.	``
--version	float	Version of the plugin.	1.0
--version-name	text	Version name of the plugin.	``
--help	boolean	Show this message and exit.	Sentinel.UNSET

uplugin remove

Deletes all files for the specified uplugin paths.

Usage:

uplugin remove [OPTIONS]

Options:

Name	Type	Description	Default
--uplugin-paths	file	uplugin-paths: A path to a uplugin to delete, can be specified multiple times.	Sentinel.UNSET
--help	boolean	Show this message and exit.	Sentinel.UNSET