• Dev Notes: Dev Notes
• Linux: Prepare Project (Linux)

Install SVN Client

Download and install TortoiseSVN from https://tortoisesvn.net/downloads.html

Get project sources from SVN

Open console from M:\MMVS_ProjectFiles (Skip if it already exists)

svn checkout svn://nastycore/MacroMicroVRService/branches/dev M:\MMVS_ProjectFiles

For the modding files the files are not included in the main SVN repo because it not part of the main project and the files can't be shared publicly.

Still in the console from M:\MMVS_ProjectFiles run:

svn checkout svn://nastycore/MMVS_Additional/branches/dev/engine/Plugins/MMVS_Add "M:\MMVS_ProjectFiles\engine\Plugins\GameFeatures\MMVS_Add"

Get Wwise

The Wwise plugin is not included and ignored in the main SVN repo. And the installation on Engine contain issues to I install it on the project side.

• Install Audiokinetic Launcher and run it. https://www.audiokinetic.com/en/download/
• Wwise -> Install A new Version -> All -> 2024.1 -> 2024.1.8.8979 -> Install (I don't use the latest because I need use a compatible version with Unreal Engine 5.4)
• Include SDK(C++) files
• Deployment Platforms: Check Linux, Windows

Get Steam Audio for Wwise (Need to be done before integrate Wwise in Project)

1. Download the latest version of the Steam Audio Wwise integration: steamaudio_wwise.zip. Extract the contents of this file to any directory of your choosing.
2. Open the Wwise Launcher.
3. In the left column, click Plugins, then click the Add from directory button that appears.
4. In the dialog box that appears, select the wwise subdirectory of the directory you extracted steamaudio_wwise.zip into, then click Select Folder. More details: https://valvesoftware.github.io/steam-audio/doc/wwise/getting-started.html

Integrate Wwise in Project

• Open the Wwise Launcher.
• Unreal Engine -> Open Other -> Navigate to MMVS UProject M:\MMVS_ProjectFiles\engine\MacroMicroVRService.uproject -> Select it.
• Unreal Engine -> Macro Micro VR Service -> Integrate Wwise in Project... Integration Version: All -> 2024.1 -> 2024.1.8.8979.3839 Unreal Engine Version: 5.4 Wwise Project: Keep: M:\MMVS_ProjectFiles\engine\engine_WwiseProject\engine_WwiseProject.wproj Click Integrate.

Patch Wwise for MMVS

We use a custom version of the Wwise Unreal Engine integration for MMVS, so you need to patch the Wwise plugin after integrate it in the project.

cd M:/MMVS_ProjectFiles/engine/plugins/Wwise
git init
git add .
git commit -m "Vanilla"
git am M:/MMVS_ProjectFiles/Other/WwisePatchs/MMVS_CustomWwiseIntegration.patch

Get Steam Audio Plugin

1. Download the Steam Audio plugin for Unreal Engine from https://valvesoftware.github.io/steam-audio
2. Extract "SteamAudio" and "SteamAudioWwise" folders into M:\MMVS_ProjectFiles\engine\Plugins\
3. Open M:\MMVS_ProjectFiles\engine\Plugins\SteamAudio\SteamAudio.uplugin and add SteamAudioWwise Dependenciesfor SteamAudio module.

    {
      "Name": "SteamAudio",
      "Type": "Runtime",
      "LoadingPhase": "Default",
      "WhitelistPlatforms": [ "Win64", "Linux", "Mac", "Android", "IOS" ],
      "AdditionalDependencies": [ "SteamAudioWwise" ]
    }

Update Unreal Engine Source Code

Macro Micro VR Service use a custom source build of Unreal Engine 5.4
This script update the source but it the future this step will be removed.
You will have to directly download the custom source from a specific repo at the prepare engine step.

Run the script "run_source_engine_update.py"

py M:\MMVS_ProjectFiles\engine\Other\SourceEngineUpdate\run_source_engine_update.py

Generate Project Files

Open console from the M:\MMVS_ProjectFiles folder.

"M:\MMVS_EngineFiles\UnrealEngine\GenerateProjectFiles.bat" -project="M:\MMVS_ProjectFiles\engine\MacroMicroVRService.uproject" -game -engine

Build Project

• Open "MacroMicroVRService.sln"
• Set Development Editor

• Right Click Solution -> Build Solution

Note about Visual Studio

Microsoft force to user to move on the latest version of visual studio. For Unreal Engine 5.4 you need to use Visual Studio 17.8 Download from here: https://learn.microsoft.com/en-us/visualstudio/releases/2022/release-history#release-dates-and-build-numbers

If you used Community version Microsoft force you use 17.14 so the build fail. but you can fix that with the following steps

1. Install Visual Studio 17.14
2. Click Modify on the 2022 version
3. In Workloads check:
   • .NET Multi-platform App UI development
   • NET desktop development
   • Desktop development with C++
4. In nstaller’s Installation Details panel - Game development with C++ enable the following options:
   • C++ profiling tools
   • C++ AddressSanitizer
   • Windows 10 and 11 SDK
   • Unreal Engine installer
5. In the Individual components tab, search for "MSVC"
6. Check "MSVC v143 - VS 2022 C++ x64/86 build tools (v14.38-17.8)" <---- This fix the build fail from using 17.14 instead of 17.8
7. Then click modify in right bot corner You will get a notification about unsported version, ignore it and click continue.

More Infos

https://voithos.io/articles/building-unreal-engine-from-source-for-vscode/ https://forums.unrealengine.com/t/help-visual-studio-preferred-version-in-5-4/2001249 https://dev.epicgames.com/documentation/en-us/unreal-engine/setting-up-visual-studio-development-environment-for-cplusplus-projects-in-unreal-engine