PSUnreal Programming: Difference between revisions

From PSwiki
Jump to navigation Jump to search
 
(50 intermediate revisions by 4 users not shown)
Line 1: Line 1:
== Installation of Unreal Engine ==


The overall process begins by installing Unreal Engine and building from source, then follows through the PSUnreal setup page.
The overall process begins by installing Unreal Engine and building from source, then follows through the PSUnreal setup page.


== Install Unreal Engine from sources on windows ==
{| style="width: 85%;"
|-
| http://www.planeshift.it/graphics/bullets/windows_icon.png|| http://www.planeshift.it/graphics/bullets/linux_icon.png || http://www.planeshift.it/graphics/bullets/mac_icon.png
|-
| [[Building PSUnreal on Windows]]|| [[Building PSUnreal on Linux]]|| [[Building PSUnreal on macOS]]
|}


A reasonably simple guide: http://www.hybridsyntax.com/en/blog/building-unreal-engine-4-on-windows.html


High level steps:


* Step 1:  Register an account at UnrealEngine and GitHub
[[Errors in Database connection]]
* Step 2:  Add your GitHub username to in your UnrealEngine profile under your dashboard
* Step 3:  Download the source code from UE4 Repo
** list remote branches with: git ls-remote https://github.com/EpicGames/UnrealEngine.git
** get source code with: git clone -b 4.20.3-release https://github.com/EpicGames/UnrealEngine.git
** this will create a "Unreal Engine" directory as child of the dir where you run the command
* Step 4:  Install Visual Studio 2017, follow [https://docs.unrealengine.com/en-us/Programming/Development/VisualStudioSetup#optionsforanewvisualstudioinstallation these instructions] to get the right components in your Visual Studio
* Step 5:  Run Setup.bat to download and install the prerequisites
* Step 6:  Run GenerateProjectFiles.bat to make project files
** if it complains about windows 8.1 sdk, just install it from [https://developer.microsoft.com/en-us/windows/downloads/windows-8-1-sdk here]
* Step 7:  If you dont have it yet, you need to make an account to login to Visual Studio.
* Step 8:  Launch Visual Studio, open UE4.sln and Build Unreal Engine 4 with Development Editor configuration and Win64 Platform
* Step 9: Copy F:\UnrealEngine\Engine\Source\ThirdParty\zlib\v1.2.8\lib\Win64\VS2015\zlib.dll to F:\Unreal Projects\MyProject2\PSUnreal\Binaries\Win64
* Step 10:  Run the UE4Editor.exe from Engine\Binaries\Win64\ subdirectory


[[Building UEEditor on Linux]]
[[Errors Unreal Compile]]


Next go here if you want to build UE for PlaneShift:
[[Errors in Running the client]]
 
[[Building PSUnreal on Windows]]
 
[[Errors Unreal Compile]]


== Engine ==
== Engine ==
Line 38: Line 26:


[[CS Code convertion]]
[[CS Code convertion]]
[[PSUnreal Classes]]
[[PSUnreal Navigation Meshes]]


[[Engine inner working]]
[[Engine inner working]]


[[List of all Unreal Engine Log categories]]
[[Build one Unreal Engine Plugin only]]


Check this article if you are suffering from slow Intellisense parsing: https://forums.unrealengine.com/development-discussion/c-gameplay-programming/65252-for-those-who-suffer-from-visual-studio-intellisense-slowness
Check this article if you are suffering from slow Intellisense parsing: https://forums.unrealengine.com/development-discussion/c-gameplay-programming/65252-for-those-who-suffer-from-visual-studio-intellisense-slowness
[[Network load]]
[[PSUnreal GDB Debug Hints]]
[[PNG File Validation]]
[[Enhanced Input]]
[[JetBrains Rider]]


== PS Unreal Engine ==
== PS Unreal Engine ==
Line 59: Line 64:
* git fetch
* git fetch
* git reset --hard (to discard local changes in case you have)
* git reset --hard (to discard local changes in case you have)
* git checkout 5.1.1-release --force
* (OPTIONAL to check if you have the right version now) git status
* (OPTIONAL if things go bad) Delete all files contained in UnrealEngine\Intermediate AND PSUnreal\Intermediate
* launch Setup.bat to update dependencies
* launch GenerateProjectFiles.bat
* COPY the files under PSUnreal\UESource in UnrealEngine main dir
* Clean the UE4 project from VS
* Rebuild UE from VS
To see tags:
* git tag --list (to list all available new tags)
* git tag --list (to list all available new tags)
* git checkout 4.20.3-release
* git log --tags --simplify-by-decoration --pretty="format:%ai %d"  (to see all tags with dates)
 
 
If you get an error for the new authentication token: "Support for password authentication was removed on August 13, 2021. Please use a personal access token instead."
 
See: https://magecomp.com/blog/generate-personal-access-token-github/
 
and use this for the last line: git remote set-url origin https://<token>@github.com/EpicGames/UnrealEngine.git/
 
== Advanced Locomotion System (ALS_CPP v4) ==
[[ALS for UE5.4]]
 
[[ALS Idle Animations]]
 
== Alternative Update Unreal Engine using Tortoise Git GUI ==
 
[https://tortoisegit.org/download/ Get TortoiseGit here].
 
To update to a newer UE version, In windows explorer right click on folder containing Unreal engine then:
 
* Delete all files contained in PSUnreal\Intermediate and UnrealEngine\Engine\Intermediate
* select > TortoiseGit > fetch. (make sure in window that opens "tags" is selected under options
* TortoiseGit > revert (to discard local changes in case you have)
* TortoiseGit > switch/checkout
** Then select tag and choose 5.1.1-release from dropdown
** Under options only have "overwrite working tree changes (force)" selected
** Press "ok" and allow it to update.
* Copy files in PSUnreal\UESource > to the appropriate folder in UnrealEngine\Engine\Source.
* launch Setup.bat to update dependencies
* launch Setup.bat to update dependencies
* launch GenerateProjectFiles.bat
* launch GenerateProjectFiles.bat
* Clean the UE4 project from VS
* Clean the UE4 project from VS
* Rebuild
* Rebuild
== Unreal Engine 5 ==
1) Tried minimal clone as the full one was failing continuously. This will create a subdirectory called 5.4.3-release<blockquote>git clone <nowiki>https://github.com/EpicGames/UnrealEngine.git</nowiki> --depth=1 --single-branch 5.4.3-release</blockquote>2) Setup.bat (or .sh or .command)
3) GenerateProjectFiles.bat ( or .sh or .command)
3) From VS 2022, it required install of Net framework 3.1, done.
4) open UE5.sln and Build Unreal Engine 5 with Development Editor configuration and Win64 Platform
== Other Stuff ==
[[Compiling Mumble Lib]]

Latest revision as of 20:03, 20 March 2025

Installation of Unreal Engine

The overall process begins by installing Unreal Engine and building from source, then follows through the PSUnreal setup page.

windows_icon.png linux_icon.png mac_icon.png
Building PSUnreal on Windows Building PSUnreal on Linux Building PSUnreal on macOS


Errors in Database connection

Errors Unreal Compile

Errors in Running the client

Engine

Best tutorials to start with UE

Packing and shipping a project

CS Code convertion

PSUnreal Classes

PSUnreal Navigation Meshes

Engine inner working

List of all Unreal Engine Log categories

Build one Unreal Engine Plugin only

Check this article if you are suffering from slow Intellisense parsing: https://forums.unrealengine.com/development-discussion/c-gameplay-programming/65252-for-those-who-suffer-from-visual-studio-intellisense-slowness

Network load

PSUnreal GDB Debug Hints

PNG File Validation

Enhanced Input

JetBrains Rider

PS Unreal Engine

Put here the notes of our architecture for Unreal.

PSUECharacter setup

Update Unreal Engine and Git commands

If you messed up your repository, try: git reset --hard

If you miss files try : git checkout .

To update to a newer UE version:

  • git fetch
  • git reset --hard (to discard local changes in case you have)
  • git checkout 5.1.1-release --force
  • (OPTIONAL to check if you have the right version now) git status
  • (OPTIONAL if things go bad) Delete all files contained in UnrealEngine\Intermediate AND PSUnreal\Intermediate
  • launch Setup.bat to update dependencies
  • launch GenerateProjectFiles.bat
  • COPY the files under PSUnreal\UESource in UnrealEngine main dir
  • Clean the UE4 project from VS
  • Rebuild UE from VS


To see tags:

  • git tag --list (to list all available new tags)
  • git log --tags --simplify-by-decoration --pretty="format:%ai %d" (to see all tags with dates)


If you get an error for the new authentication token: "Support for password authentication was removed on August 13, 2021. Please use a personal access token instead."

See: https://magecomp.com/blog/generate-personal-access-token-github/

and use this for the last line: git remote set-url origin https://<token>@github.com/EpicGames/UnrealEngine.git/

Advanced Locomotion System (ALS_CPP v4)

ALS for UE5.4

ALS Idle Animations

Alternative Update Unreal Engine using Tortoise Git GUI

Get TortoiseGit here.

To update to a newer UE version, In windows explorer right click on folder containing Unreal engine then:

  • Delete all files contained in PSUnreal\Intermediate and UnrealEngine\Engine\Intermediate
  • select > TortoiseGit > fetch. (make sure in window that opens "tags" is selected under options
  • TortoiseGit > revert (to discard local changes in case you have)
  • TortoiseGit > switch/checkout
    • Then select tag and choose 5.1.1-release from dropdown
    • Under options only have "overwrite working tree changes (force)" selected
    • Press "ok" and allow it to update.
  • Copy files in PSUnreal\UESource > to the appropriate folder in UnrealEngine\Engine\Source.
  • launch Setup.bat to update dependencies
  • launch GenerateProjectFiles.bat
  • Clean the UE4 project from VS
  • Rebuild

Unreal Engine 5

1) Tried minimal clone as the full one was failing continuously. This will create a subdirectory called 5.4.3-release

git clone https://github.com/EpicGames/UnrealEngine.git --depth=1 --single-branch 5.4.3-release

2) Setup.bat (or .sh or .command)

3) GenerateProjectFiles.bat ( or .sh or .command)

3) From VS 2022, it required install of Net framework 3.1, done.

4) open UE5.sln and Build Unreal Engine 5 with Development Editor configuration and Win64 Platform

Other Stuff

Compiling Mumble Lib