uProject and Engine Installation
See option 1 for standard install, or option 2 for install along with Github desktop to allow for easy updates. Be sure to install any missing prerequisites first. See section 3 for troubleshooting.
I highly recommend following option 2, as you can update with the click of a button and updates will only download changed files.
For Audio Modding switch the the "AudioBranch" branch of this repo and follow the readme from there.
If you have not done so already, follow the instructions here to create and link a Github account to an Epic Games account: https://www.unrealengine.com/en-US/ue-on-github
They will send you two confirmation emails, one of which may require that you follow a link to verify the connection.
Download and install Visual Studio. It can be 2017, 2019, or 2022. It can be found here (https://visualstudio.microsoft.com/downloads/), and you should download the "Community" version. You may need to log in to a Microsoft account to access this link.
If you are installing for the first time, be sure to include the below options.
To add C++ tools to your VS installation, make sure you select Game development with C++ under Workloads, as well as the Unreal Engine Installer option. You must have at least one Windows 10 SDK, Windows 11 SDK will not be sufficient.
Proceed to the links https://github.com/narknon/PhoenixUProj and https://github.com/narknon/UnrealEngine-CEEnd/tree/4.27-chaos.
Click on the green arrow to the right, and select download zip.
Once the downloads are complete, extract each to separate folders (I personally prefer not to use Desktop or Documents for Unreal installs, and instead install on root of my drive, or close to root). Be sure not to use a very long path or UE will give errors.
Once extracted, rename the engine folder (UnrealEngine-CEEnd) to whatever you would like just to ensure that the path to the files is not gigantic.
Inside the engine root folder (not the /Engine/ folder within the downloaded folders), double click the file named Setup.bat. Wait for this to complete. At the very end of its process, it will pop-up a Windows Elevated rights request in the background, so be sure to check your taskbar and select and allow the elevation.
Then navigate to find the UnrealVersionSelector-Win64-Shipping.exe at the following path: \Engine\Binaries\Win64\UnrealVersionSelector-Win64-Shipping.exe. Double click this file. It will then ask if you wish to register the directory as an Unreal installation. Select yes. It should then say registration succesful.
Inside the folder to which you extracted the project, find the Phoenix.uproject file. Right click on this file, and select "Switch Unreal Engine Version". If you correctly registered the engine directory as an Unreal directory, it should simply appear in the dropdown. If it does not appear automatically, click the three dots to the right of the path. Navigate to the folder to which you extracted the engine, and select the root folder (i.e., the folder that contains the setup.bat file).
Following this, the uproject should generate a .sln file. If this file does not generate, something went wrong. Try right clicking on the TresGame.uproject again, and this time select "Generate Project Files." If the .sln still does not generate, something else is happening. Navigate to your Saved/Logs folder to find a file titled unrealversionselector-2022.06.29-09.16.08.log (the date will be the current date/time), and check to see what the error was, or post the file in the #kh3-modding channel on the discord for help.
If the .sln did generate, you're done! Double click on the Phoenix.uproject to launch the project!
Github Desktop: https://desktop.github.com/ (install with defaults, being sure to include any options relating to adding GIT as an environmental variable/path.)
Git CLI: https://git-scm.com/downloads (install with defaults, being sure to include any options relating to adding GIT as an environmental variable/path.)
Create a folder in which you would like to install the engine (I personally prefer not to use Desktop or Documents for Unreal installs, and instead install on root of my drive, or close to root).
Open the folder, hold Shift, and Right Click. The Right Click context menu should include the option "Open Powershell Window Here". Select this option.
A new console window should then open.
Copy/paste the below command into the console window.
git clone --branch 4.27-chaos --single-branch https://github.com/narknon/UnrealEngine-CEEnd.git
Wait for the download to complete based on the output in the console window.
Once completed, rename the engine folder (UnrealEngine-CEEnd) to whatever you would like just to ensure that the path to the files is not gigantic.
Inside the engine root folder (not the /Engine/ folder within the downloaded folders), double click the file named Setup.bat. Wait for this to complete. At the very end of its process, it will pop-up a Windows Elevated rights request in the background, so be sure to check your taskbar and select and allow the elevation.
Then navigate to find the UnrealVersionSelector-Win64-Shipping.exe at the following path: \Engine\Binaries\Win64\UnrealVersionSelector-Win64-Shipping.exe. Double click this file. It will then ask if you wish to register the directory as an Unreal installation. Select yes. It should then say registration succesful.
Create a new folder that is not within the engine folder to which you would like to install the uProject.
Open a new powershell window from within this new folder. Paste the below command into the powershell window
git clone https://github.com/narknon/PhoenixUProj.git
Wait for the download to complete based on the output in the console window. This should be much quicker than the engine download.
Once complete, find the Phoenix.uproject file in this folder. Right click on this file, and select "Switch Unreal Engine Version". If you correctly registered the engine directory as an Unreal directory, it should simply appear in the dropdown. If it does not appear automatically, click the three dots to the right of the path. Navigate to the folder to which you extracted the engine, and select the root folder (i.e., the folder that contains the setup.bat file).
Following this, the uproject should generate a .sln file. If this file does not generate, something went wrong. Try right clicking on the TresGame.uproject again, and this time select "Generate Project Files." If the .sln still does not generate, something else is happening. Navigate to your Saved/Logs folder to find a file titled unrealversionselector-2022.06.29-09.16.08.log (the date will be the current date/time, not the one listed here), and check to see what the error was, or post the file in the #kh3-modding channel on the discord for help.
If the .sln did generate, you should now be able to launch the project by double clicking on the Phoenix.uproject. Proceed to the Github Desktop steps below to allow one-button updates.
Open Github Desktop and navigate to File->Add Local Repository; or press CTRL+O.
In the new dialog, press "Choose" and navigate to the folder to which you cloned the uproject (this will be the folder that contains the hidden .git folder, not the folder that is a directory up from that).
Once inside this folder, press select folder.
The repository should now be added as the current repository.
Do the same for the engine. Now you should be able to swap between both by clicking the "Current Repository" button. You can also switch between branches easily if you'd like to try out one of the experimental branches.
If your problem is not solved by the below, then navigate to Saved/Logs for both your uProject folder, your engine folder, and the automation tool (see below paths), and request help in the server by sending the relevant logs from each.
{EngineFolderRoot}\Engine\Saved\Logs
{EngineFolderRoot}\Engine\Programs\AutomationTool\Saved\Logs
{EngineFolderRoot}\Engine\Programs\UnrealHeaderTool\Saved\Logs
{ProjectFolderRoot}\Saved\Logs