{ "info": { "author": "Marvin Pohl", "author_email": "marvin@lab132.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 5 - Production/Stable", "Environment :: Plugins", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Operating System :: MacOS", "Operating System :: Microsoft :: Windows", "Operating System :: POSIX :: Linux", "Programming Language :: C++", "Programming Language :: Python :: 2.7", "Topic :: Software Development :: Build Tools" ], "description": "# buildbot-UnrealEngine\nBuildbot Plugin to run Commands using the Unreal Automation Tool\n\n[](https://badge.fury.io/py/buildbot-UnrealEngine) [](https://travis-ci.org/pampersrocker/buildbot-UnrealEngine) [](https://raw.githubusercontent.com/pampersrocker/buildbot-UnrealEngine/master/LICENSE)\n\n# Installation\n\n```\npip install buildbot_UnrealEngine\n```\n\nThis enables the additional step commands as plugins inside buildbot (which are imported via `from buildbot.plugins import steps`)\n\n# Usage\n\n```py\nfrom buildbot.plugins import steps\n\nfactory = util.BuildFactory()\n\n###### Build commands\n\nfactory.addStep(\n steps.UEBuild(\n \"Engine_Location\",\n \"Path_To_Project.uproject\",\n \"TargetName\",\n # Additional Parameters, see below\n )\n)\n\nfactory.addStep(\n steps.UERebuild(\n \"Engine_Location\",\n \"Path_To_Project.uproject\",\n \"TargetName\",\n # Additional Parameters, see below\n )\n)\n\nfactory.addStep(\n steps.UEClean(\n \"Engine_Location\",\n \"Path_To_Project.uproject\",\n \"TargetName\",\n # Additional Parameters, see below\n )\n)\n\n###### BuildCookRun\n\nfactory.addStep(\n steps.BuildCookRun(\n \"Engine_Location\",\n \"Path_To_Project.uproject\",\n # Additional Parameters, see below\n )\n)\n```\n\n# Parameters\n\nAll commands share the following base parameters:\n\n| Parameter | Type/Options | Description |\n| --- | --- | --- |\n| engine_path |string (required) | The location to the used engine, the path needs to point to the root folder of the engine (in this folder are at least the `Engine`, `FeaturePacks`, `Samples` and `Templates` folders) |\n| project_path | string (required) | The absolute location to the uproject file to be used. (Usually a `Interpolate(\"...\")` to build the path using the current builddir) |\n| build_platform | string (default `\"Windows\"`), Options: `\"Windows\"` `\"Linux\"` `\"Mac\"` | The platform on which the build itself will run, used to determine which scripts to run |\n| engine_type | string (default `\"Rocket\"`), Options: `\"Source\"` `\"Installed\"` `\"Rocket\"` |