filfreire/SimpleFPSTemplate_filfreire

personal fork of https://github.com/tomlooman/SimpleFPSTemplate

SimpleFPSTemplate

Simple C++ FPS Template for Unreal Engine 4. This fork is adapted from https://github.com/tomlooman/SimpleFPSTemplate.

Prerequisites

For Windows 10/11:

• Install Unreal Engine 4.27 (and all needed sub-dependencies)
• Install Visual Studio 2022
• Install all dependencies mentioned on official documentation

(Tested on a Windows 10 Pro, version 22H2)

How to build

First, clone the repository, make sure you have everything listed on Prerequisites setup and then cd into the cloned folder.

Use .\scripts\Build.bat batch file to compile/build the project:

# UNREAL_PATH - Unreal engine install path, e.g. C:\Epic Games\UE_4.27
# PROJECT_NAME - project name, e.g. FPSGame.uproject

.\scripts\Build.bat $env:UNREAL_PATH (Get-Location).Path $env:PROJECT_NAME

How to run tests

To run tests, use the .\scripts\RunTests.bat batch file:

# UNREAL_PATH - Unreal engine install path, e.g. C:\Epic Games\UE_4.27
# PROJECT_NAME - project name, e.g. FPSGame.uproject
# TEST_SUITE_TO_RUN - e.g. FPSGameTests.
# TEST_REPORT_FOLDER - e.g. TestResults
# TEST_LOGNAME - e.g. RunTests.log
# UNREAL_EDITOR_CMD - UE4Editor-Cmd.exe (Unreal 4) UnrealEditor-Cmd.exe (Unreal 5)

.\scripts\RunTests.bat $env:UNREAL_PATH (Get-Location).Path $env:PROJECT_NAME $env:TEST_SUITE_TO_RUN $env:TEST_REPORT_FOLDER $env:TEST_LOGNAME $env:UNREAL_EDITOR_CMD

How to package and run

To package a game build for Win64 platform, r un .\scripts\Package.bat on a Powershell terminal:

# UNREAL_PATH - Unreal engine install path, e.g. C:\Epic Games\UE_4.27
# PROJECT_NAME - project name, e.g. FPSGame.uproject
# TARGET_NAME - name of target, e.g. FPSGame
# PACKAGE_FOLDER - Folder name where to place the packaged game binaries, e.g. PackageResults

.\scripts\Package.bat $env:UNREAL_PATH (Get-Location).Path $env:PROJECT_NAME $env:TARGET_NAME $env:PACKAGE_FOLDER