Skip to content

Latest commit

 

History

History
77 lines (72 loc) · 5.81 KB

README.md

File metadata and controls

77 lines (72 loc) · 5.81 KB
Raw

UePrjCreator

WindowsOs-logo cpp-logo UnrealEngine-logo

Qa test and coverage

cpplint cppcheck LinesOfСode Comments amount testsuites tests coverage

Tool for create Unreal Engine *.uproject file and directory structure from command line. From scratch or from template.
Not only VS project files. Not only UnrealEngine project files for your IDE.
It completely repeats the behavior of UnrealEngine when creating a new project through the "Project Explorer" without a long full load of the engine.

Features

The resulting directory containing the *.uproject file is ready to be built into an executable via UnrealEngine UBT. Can use UnrealEngine templates. If the template contains C++ classes, IDE project files will be generated. The tool contains an internal template for building an executable file without building *Editor.dll library.
Under the hood, the tool loads the Unreal core, performs minimal initialization, and calls the core functionality.

Requirements

Requires installed Unreal Engine version 4.

Install

The tool consists of one file. Does not require installation.

Usage

Animated command line and responses https://alex0vsky.github.io/posts/UePrjCreator

For example, the desired fully qualified filename for the *.uproject location would be C:\UePrj1\UePrj1.uproject
For the term UnrealEngine, the abbreviation Ue will be used below.

  • Generate a standart blank project
    • Easy start for the latest version of the installed Ue:
      UePrjCreator "C:\UePrj1\UePrj1.uproject"
    • Run for a specific installed version of the Ue:
      UePrjCreator "C:\UePrj1\UePrj1.uproject" --UeVersion=4.26
    • Run for installed Ue in certain path in quotes:
      UePrjCreator "C:\UePrj1\UePrj1.uproject" --UeInstallDir="C:\Program Files\Epic Games\UE_4.26"
  • Generate from an existing template with a quoted path for a specific installed version of Ue:
    UePrjCreator "C:\UePrj1\UePrj1.uproject" --UeVersion=4.26 --Tpl="C:\Program Files\Epic Games\UE_4.26\Templates\TP_SideScroller\TP_SideScroller.uproject"
  • Generate for a game with one executable, without *Engine.dll, for a specific installed version of Ue:
    UePrjCreator "C:\UePrj1\UePrj1.uproject" --UeVersion=4.26 --DevTpl

More options:

  • Settings for *%yourProjectName%\Config\DefaultEngine.ini section [/Script/HardwareTargeting.HardwareTargetingSettings]
--TargetedHardwareClass=<value> [Unspecified, Maximum, Scalable>, default: Scalable]
--DefaultGraphicsPerformance=<value> [Unspecified, Desktop, Mobile>, default: Desktop]

Tests

CI github actions

  • qa UnitTest and coverage: google-test, OpenCppCoverage/OpenCppCoverage;
  • qa staticAnalysis and codeMetrics: cppcheck, py metrixpp, py cpplint;
  • auxiliary: py junitparser, py burlachenkok/gtest_report(fork).

Build

Building the project and tests from the source code requires the presence of the Microsoft Visual Studio 2019 Community, and using *.sln and *.vcxproj project files. The project is also ready to be built via clang version 12.0.0, which comes with VIsualStudioCommunity2019.

Contributing

Can ask questions. PRs are accepted. No requirements for contributing.

Thanks

License

See the LICENSE file for license rights and limitations (MIT).