HK_Project is a WIP uProject for modding the game. Note that some fixes and edits are still in progress, so updates will be frequent and not everything will work.
STRAY and any other trademarks used throughout this project are the property of their respective owners.
This software is provided by the author "as is". In no event shall the author be liable for any direct, indirect, incidental, special, exemplary, or consequential damages (including, but not limited to procurement of substitute goods or services; loss of use, data, or profits; or business interruption) however caused and on any theory of liability, whether in contract, strict liability, or tort (including negligence or otherwise) arising in any way out of the use of this software, even if advised of the possibility of such damage.
Note - the screenshots are taken from my instructions for a different game and therefore don't match the names of the files we are using here.
See option 1 for install along with Github desktop to allow for easy updates, or option 2 for standard install. Be sure to install any missing prerequisites first.
I highly recommend following option 1, as you can update with the click of a button and updates will only download changed files.
Download and install Visual Studio 2017 (2019 or 2022 should also work as this game is built on 4.27). It can be found here (https://my.visualstudio.com/Downloads?q=visual%20studio%202017&wt.mc_id=o~msft~vscom~older-downloads), and you should download the "Community" version (Visual Studio Community 2017 (version 15.9)). 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 these additional options.
C++ profiling tools
C++ AddressSanitizer (optional)
Nuget Package Manager
Windows 10 SDK
To include the UE installer when installing VS, locate the Summary sidebar on the right, expand Game Development with C++, and under Optional, make sure the checkbox for Unreal Engine installer is checked to enable it.
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 new folder in 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 --branch main https://github.com/narknon/HK_Project.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 HK_project.uproject file in this folder. Right click on this file, and select "Switch Unreal Engine Version" and select "4.27".
Following this, the uproject should generate a .sln file. If this file does not generate, something went wrong. Try right clicking on the HK_project.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 HK_project.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.
You should be able to switch between branches easily if you'd like to try out one of the experimental branches.
From this repository, click on the green arrow to the top right, and select download zip.
Once the download is complete, extract to a folder (I personally prefer not to use Desktop or Documents for Unreal installs, and instead install on root of my drive, or close to root).
Inside the folder to which you extracted the project, find the HK_project.uproject file. Right click on this file, and select "Switch Unreal Engine Version" and select "4.27".
Following this, the uproject should generate a .sln file. If this file does not generate, something went wrong. Try right clicking on the HK_project.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 HK_project.uproject to launch the project!
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