Project template for creating cross-platform desktop applications based on Unrial Engine. For the GUI, the Slate UI Framework (part of UnrealEngine) is used.
This repository is a basic standalone application template based on the Slate UI Framework. This is how Gerke Max Preussner says about the framework:
Slate is written entirely in C++ and runs on all Unreal Engine 4 supported platforms. It is render interface agnostic, which allows it to be used in standalone desktop and mobile applications that do not depend on the game engine. Its architecture rests on two powerful concepts that distinguish it from many classical frameworks: declarative syntax and composition.
This repository contains the basic foundation for your future cross-platform application.
As far as I know, there is currently no easy way to generate such an almost empty project. The GitHub repository with the UE4 contains only a few examples of stand-alone applications, on the basis of which I made this repository for quick and convenient generation of your own application.
- In order for the "TemplateRenamer" Tool in the form of a script to run correctly, you need to install Python 3 (tested with 3.8, 3.9, 3.12):
- In order for the project to be generated, compiled and run after renaming, you need to have an up-to-date version of Unrial Engine (tested on 5.2, 5.3) compiled from sources from GitHub (Release branch is recommended). For this, there is a detailed instruction from EpicGames:
In order to get a new project with a new name, you need to do the following:
- Install and configure all requirements
- Go to the root of the repository and run the script
CreatNewProject
(CreatNewProject.bat
for Windows andCreatNewProject.sh
for Linux and MacOS). This step will execute theTools/TemplateNamer/TemplateRenamer.py
script interactively. - In the command line window, you will first need to enter the new project name, and then specify the path where to place the new project. The console will look something like this:
Windows Cmd | Linux bash |
---|---|
![]() |
![]() |
- Go to the folder with the newly created project, right-click on the
*.uproject
file and select "Switch Unreal Engine version" or "Generate project files" (there are alternative ways for the command line, more details here) - Now open your IDE for which the project was generated, select the project to start, and after compilation, you will see an empty window.
Note: It is important to understand that at the first compilation, building the project can take a long time, since IDE tries to index the entire source code of the engine, as well as build the modules that are included in the dependencies. In the future, if you do not change the engine code, then the dependent modules will not be rebuilt, which means that the assembly of your project will be faster.
All screenshots are taken from base app SlateViewer