Install

class uetools.commands.plugin.install.Install[source]

Install a plugin to an unreal project.

Examples

# This will install the plugin inside RTSGame/Plugins/
# it will download the repository on put it inside the RTSGame/Plugins/ folder
uecli install --project RTSGame VoxelPlugin https://github.com/Phyronnaz/VoxelPlugin --enable

# This will install the plugin inside RTSGame/Plugins/
# it will execute the following command:
#   - git submodule add https://github.com/Phyronnaz/VoxelPlugin Plugins/VoxelPlugin
#
uecli install --project RTSGame VoxelPlugin https://github.com/Phyronnaz/VoxelPlugin --enable --destination Plugins --submodule

# disable the plugin
uecli disable --project RTSGame VoxelPlugin

name: str = 'install'

class Arguments[source]

Arguments(plugin: str, url: str, project: str = None, destination: Optional[str] = ‘Plugins’, submodule: bool = False, enable: bool = False, force: bool = False)

plugin: str

url: str

project: str = None

destination: str | None = 'Plugins'

submodule: bool = False

enable: bool = False

force: bool = False

static execute(args)[source]: Execute the command

uetools.commands.plugin.install.COMMANDS: alias of Install