Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Alex0vSky/UePrjCreator
Unreal Engine project generator from command line
https://github.com/Alex0vSky/UePrjCreator
command-line command-line-tool cplusplus cplusplus-17 cpp cpp17 unreal-engine unreal-engine-4 windows
Last synced: 3 months ago
JSON representation
Unreal Engine project generator from command line
- Host: GitHub
- URL: https://github.com/Alex0vSky/UePrjCreator
- Owner: Alex0vSky
- License: mit
- Created: 2023-08-12T02:32:47.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-02-05T01:40:48.000Z (almost 1 year ago)
- Last Synced: 2024-07-30T20:58:37.933Z (6 months ago)
- Topics: command-line, command-line-tool, cplusplus, cplusplus-17, cpp, cpp17, unreal-engine, unreal-engine-4, windows
- Language: C++
- Homepage: https://alex0vsky.github.io/posts/UePrjCreator/
- Size: 2.8 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# _UePrjCreator_
[](
https://en.wikipedia.org/wiki/Microsoft_Windows
) [](
https://en.wikipedia.org/wiki/C++
) [](
https://en.wikipedia.org/wiki/UnrealEngine
)
[](
https://github.com/Alex0vSky/UePrjCreator/actions/workflows/qa-UnitTest-Coverage.yml
)
[](
https://Alex0vSky.github.io/project-qa-report/UePrjCreator/cpplint.xml
) [](
https://Alex0vSky.github.io/project-qa-report/UePrjCreator/cppcheck.xml
) [](
https://Alex0vSky.github.io/project-qa-report/UePrjCreator/metrixpp.txt
) [](
https://Alex0vSky.github.io/project-qa-report/UePrjCreator/metrixpp.txt
) [](
https://Alex0vSky.github.io/project-qa-report/UePrjCreator/GoogleTestCombinedOutput/index.html
) [](
https://Alex0vSky.github.io/project-qa-report/UePrjCreator/HtmlReportOcc/index.html
)
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= [Unspecified, Maximum, Scalable>, default: Scalable]
> --DefaultGraphicsPerformance= [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
+ Inspired by video [Unreal Engine C++ Project Setup, From Scratch](https://www.youtube.com/watch?v=94FvzO1HVzY) of youtube blogger __Alex Forsythe__ ([GitHubUser](https://github.com/awforsythe), [More](http://awforsythe.com)).
+ [morrisfranken/argparse](https://github.com/morrisfranken/argparse)
+ [Neargye/magic_enum](https://github.com/Neargye/magic_enum)
+ googletest+googlemock [google/googletest](https://github.com/google/googletest)
+ vs_google_test_explorer_namespace.h [Macro to Enable Namespaces in Google Test Adapter for Visual Studio](https://bitbucket.org/CadActive/workspace/snippets/GrBakB/macro-to-enable-namespaces-in-google-test) by James Sullivan ([More](https://developercommunity.visualstudio.com/t/test-explorer-namespace-seems-to-not-be-working/663974))
## License
See the [LICENSE](https://github.com/Alex0vSky/UePrjCreator/blob/main/LICENSE) file for license rights and limitations (MIT).