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

Install SVN Client

sudo apt update
sudo apt install subversion

Get project sources from SVN

Open console from /media/$USER/macro_micro_vr_service/MMVS_ProjectFiles (Skip if it already exists)

svn checkout svn://nastycore/MacroMicroVRService/branches/dev /media/$USER/macro_micro_vr_service/MMVS_ProjectFiles/engine

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 /media/$USER/macro_micro_vr_service/MMVS_ProjectFiles run:

svn checkout svn://nastycore/MMVS_Additional/branches/dev/engine/Plugins/MMVS_Add "/media/$USER/macro_micro_vr_service/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.8898 -> 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 /media/$USER/macro_micro_vr_service/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.8898.3839
  Unreal Engine Version: 5.4
  Wwise Project: Keep: /media/$USER/macro_micro_vr_service/MMVS_ProjectFiles/engine/MMVS_WwiseProject/MMVS_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 /media/$USER/macro_micro_vr_service/MMVS_ProjectFiles/engine/plugins/Wwise
git init
git remote add origin https://github.com/xavier150/Wwise-for-MMVS.git
git fetch origin
git checkout -f -b mmvs-wwise-2024 origin/mmvs-wwise-2024

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 /media/$USER/macro_micro_vr_service/MMVS_ProjectFiles/engine/Plugins/
3. Open /media/$USER/macro_micro_vr_service/MMVS_ProjectFiles/engine/Plugins/SteamAudio/SteamAudio.uplugin and add SteamAudioWwise dependencies for 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"

python /media/$USER/macro_micro_vr_service/MMVS_ProjectFiles/engine/Other/SourceEngineUpdate/run_source_engine_update.py

Generate Project Files

Open console from the /media/$USER/macro_micro_vr_service/MMVS_ProjectFiles folder.

"/media/$USER/macro_micro_vr_service/UnrealEngine/GenerateProjectFiles.sh" -project="/media/$USER/macro_micro_vr_service/MMVS_ProjectFiles/engine/MacroMicroVRService.uproject" -game -engine -vscode

Build Project

• Open "MacroMicroVRService.code-workspace"
• Set LaunchTagEditor (Development)
• Run Build (Ctrl+F5)

More Infos

https://voithos.io/articles/building-unreal-engine-from-source-for-vscode/