https://github.com/filfreire/simplefpstemplate_filfreire

"own" fork of tomlooman/SimpleFPSTemplate repository
https://github.com/filfreire/simplefpstemplate_filfreire

cpp gamedev unreal unreal-engine unreal-engine-4 unreal-engine-5

Last synced: 4 days ago
JSON representation

"own" fork of tomlooman/SimpleFPSTemplate repository

• Host: GitHub
• URL: https://github.com/filfreire/simplefpstemplate_filfreire
• Owner: filfreire
• Created: 2020-04-07T19:48:26.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-01-04T19:06:28.000Z (9 months ago)
• Last Synced: 2024-01-04T20:25:03.142Z (9 months ago)
• Topics: cpp, gamedev, unreal, unreal-engine, unreal-engine-4, unreal-engine-5
• Language: C++
• Homepage:
• Size: 60.3 MB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# SimpleFPSTemplate

[![build workflow status](https://github.com/filfreire/SimpleFPSTemplate_filfreire/actions/workflows/build.yml/badge.svg)](https://github.com/filfreire/SimpleFPSTemplate_filfreire/actions/workflows/build.yml)

Simple C++ FPS Template for Unreal Engine 4. This fork is adapted from .

## Prerequisites

For Windows 10/11:

- Install [Unreal Engine 4.27](https://www.unrealengine.com/en-US/download) (and all needed sub-dependencies)

- Install [Visual Studio 2022](https://visualstudio.microsoft.com/vs/)

- Install all dependencies mentioned on [official documentation](https://docs.unrealengine.com/4.27/en-US/setting-up-visual-studio-development-environment-for-cplusplus-projects-in-unreal-engine/)

(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:

```powershell

# 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:

```powershell

# 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:

```powershell

# 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

```